FrameRecorder Class¶
Description¶
MonoBehaviour which controls InputFrameRecorder and VideoInputFrameRecorder in the scene, providing a few extensions in the Unity environment.
It will be automatically assembled into ARSession.Assembly .
Behaviour .enabled can be used to control record start/stop.
Enums¶
public enum FrameRecorder.InternalFormat |
Internal data format. |
public enum FrameRecorder.RecorderStatus |
Recording status. |
Classes¶
public class FrameRecorder.RecordingConfiguration |
Recording configuration.. |
public class FrameRecorder.RecordStartEvent |
File name without extension. Callback parameter represents file path in recording. |
public class FrameRecorder.RecordFinishEvent |
Recorder finish event. Callback parameter will be false when recording has error(s). |
Fields¶
AutoStart¶
- C#
public bool AutoStart
Start record automatically after session start.
Configuration¶
- C#
public FrameRecorder.RecordingConfiguration Configuration
Recording configuration. Set before recording start (OnEnable or ARSession.StartSession ).
OnReady¶
- C#
public UnityEngine.Events.UnityEvent OnReady
Event when the recorder can start.
OnRecording¶
- C#
public FrameRecorder.RecordStartEvent OnRecording
Recorder start event.
OnFinish¶
- C#
public FrameRecorder.RecordFinishEvent OnFinish
Recorder finish event.
Properties¶
enabled¶
- C#
public bool enabled { get; set; }
Start/Stop recording when ARSession is running. Recording will start only when MonoBehaviour .enabled is true after session started. MonoBehaviour .enabled is default false and will be set to FrameRecorder.AutoStart in ARSession .Awake.
Status¶
- C#
public FrameRecorder.RecorderStatus Status { get; }
Recording status.
RecordingFile¶
- C#
public string RecordingFile { get; }
Absolute path of the file being recorded.
RecordingFormat¶
- C#
public Optional< FrameRecorder.InternalFormat > RecordingFormat { get; }
Format of the file being recorded.
AvailableFormats¶
- C#
public List< FrameRecorder.InternalFormat > AvailableFormats { get; }
Available formats. Vary on different platforms.