FrameRecorder Class¶

Description¶

MonoBehaviour which controls InputFrameRecorder or VideoInputFrameRecorder in the scene, providing a few extensions in the Unity environment. There is no need to use InputFrameRecorder or VideoInputFrameRecorder directly.

It will be automatically assembled into ARSession.Assembly if selected FrameRecorder.Format is available on the device.

Behaviour .enabled can be used to control record start/stop.

Enums¶

public enum FrameRecorder.InternalFormat	Internal data format.
public enum FrameRecorder.RecorderStatus	Recording status.

MonoBehaviour Messages¶

private void Awake()

private void OnEnable()

private void OnDisable()

private void OnDestroy()

Fields¶

AutoStart¶

C#: public bool AutoStart

Start record automatically after session start.

AutoFilePath¶

C#: public bool AutoFilePath

Generate file path automatically. The file will be stored into Application .persistentDataPath, and you need to make sure the file can be get out in your own way.

FilePathType¶

C#: public WritablePathType FilePathType

File path type. Set before OnEnable or ARSession.StartSession .

FilePath¶

C#: public string FilePath

File path. Set before OnEnable or ARSession.StartSession .

OnReady¶

C#: public UnityEngine.Events.UnityEvent OnReady

Event when the recorder can start.

OnRecording¶

C#: public UnityEngine.Events.UnityEvent OnRecording

Recorder start event.

OnFinish¶

C#: public FrameRecorder.RecordFinishEvent OnFinish

Recorder finish event.

Properties¶

Status¶

C#: public FrameRecorder.RecorderStatus Status { get; }

Recording status.

FileInRecording¶

C#: public string FileInRecording { get; }

Absolute path of the file being recorded.

Format¶

C#: public FrameRecorder.InternalFormat Format { get; set; }

Format to be recorded. FrameRecorder.InternalFormat.H264 or FrameRecorder.InternalFormat.H265 may not work on some devices.