VideoInputFrameRecorder Class¶

This type is an EasyAR Sense API in C#: VideoInputFrameRecorder . Some descriptions may not apply to Unity environment on this page.

This type is fully wrapped into Unity components: FrameRecorder . There is no need to use this type directly.

Description¶

Input frame recorder.

There is an input frame input port and an input frame output port. It can be used to record input frames into an EIF MKV file. Refer to Overview .

All members of this class is thread-safe.

Methods¶

isAvailable¶

C#: public static bool isAvailable()

Checks if the component is available. It returns true only on MacOS, iOS and Android.

input¶

C#: public virtual InputFrameSink input()

Input port.

accelerometerResultSink¶

C#: public virtual AccelerometerResultSink accelerometerResultSink()

Optional. Input port for accelerometer result. See also AccelerometerResultSink .

gyroscopeResultSink¶

C#: public virtual GyroscopeResultSink gyroscopeResultSink()

Optional. Input port for gyroscope result. See also GyroscopeResultSink .

attitudeSensorResultSink¶

C#: public virtual AttitudeSensorResultSink attitudeSensorResultSink()

Optional. Input port for attitude sensor. See also AttitudeSensorResultSink .

magnetometerResultSink¶

C#: public virtual MagnetometerResultSink magnetometerResultSink()

Optional. Input port for magnetometer. See also MagnetometerResultSink .

locationResultSink¶

C#: public virtual LocationResultSink locationResultSink()

Optional. Input port for location result. See also LocationResultSink .

proximityLocationResultSink¶

C#: public virtual ProximityLocationResultSink proximityLocationResultSink()

Optional. Input port for proximity location result. See also ProximityLocationResultSink .

bufferRequirement¶

C#: public virtual int bufferRequirement()

Camera buffers occupied in this component.

output¶

C#: public virtual InputFrameSource output()

Output port.

create¶

C#: public static VideoInputFrameRecorder create()

Creates an instance.

start¶

C#: public virtual bool start(string filePath, CameraDeviceType cameraDeviceType, int cameraOrientation, int initialScreenRotation, VideoInputFrameRecorderVideoCodec codec, int width, int height, double frameRate, string metadata)

Starts frame recording. The definitions of cameraDeviceType, cameraOrientation and cameraOrientation are the same as in CameraParameters . initialScreenRotation is the initial screen rotation when recording data, and it will be used in rendering for playback.

stop¶

C#: public virtual void stop()

Stops frame recording. It will only stop recording and will not affect connection.

setAutomaticCompletionCallback¶

C#: public virtual void setAutomaticCompletionCallback( CallbackScheduler callbackScheduler, Optional<Action<VideoInputFrameRecorderCompletionReason>> automaticCompletionCallback)

Sets callback for automatic completion of recording.