Table of Contents

Class FrameRecorder

Switch to guide

Namespace
easyar
Assembly
EasyAR.Sense.dll

A MonoBehaviour that controls easyar.InputFrameRecorder and easyar.VideoInputFrameRecorder in the scene and provides functional extensions in the Unity environment.

It will be automatically assembled into Assembly.

enabled can control recording start and stop.

[DisallowMultipleComponent]
public class FrameRecorder : MonoBehaviour
Inheritance
FrameRecorder

Fields

AutoStart

Automatically starts recording after Session startup.

public bool AutoStart

Configuration

Recording configuration. It can be set before recording, before OnEnable or StartSession().

public FrameRecorder.RecordingConfiguration Configuration

OnFinish

Event when recording ends.

public FrameRecorder.RecordFinishEvent OnFinish

OnReady

Event when recording can start.

public UnityEvent OnReady

OnRecording

Event when recording starts.

public FrameRecorder.RecordStartEvent OnRecording

Properties

AvailableFormats

All available formats, varying by platform.

public List<FrameRecorder.InternalFormat> AvailableFormats { get; }

RecordingFile

Absolute path of the file currently being recorded.

public string RecordingFile { get; }

RecordingFormat

Format of the file currently being recorded.

public Optional<FrameRecorder.InternalFormat> RecordingFormat { get; }

Status

Recording status.

public FrameRecorder.RecorderStatus Status { get; }

enabled

Starts/stops recording while ARSession is running. After the session starts, recording starts only when MonoBehaviour.enabled is true. MonoBehaviour.enabled defaults to false and will be set to AutoStart in ARSession.Awake.

public bool enabled { get; set; }