Table of Contents

Class VideoRecorder

Namespace
easyar
Assembly
EasyAR.Sense.dll

Controls the Recorder in the scene, providing functional extensions within the Unity environment.

Users have full control over video recording content. Screen recording does not silently capture the screen or camera output. Video data must be continuously passed in via RecordFrame(RenderTexture).

Note: Only available in non-enterprise Sense, on Android GLES2/3 with multi-threaded rendering disabled.

public class VideoRecorder : MonoBehaviour
Inheritance
VideoRecorder

Fields

AudioProfile

Audio configuration. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.AudioProfiles AudioProfile

CustomVideoProfile

Custom screen recording configuration. Used when VideoProfile == Custom. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.VideoProfiles CustomVideoProfile

FilePath

Screen recording file output path. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public string FilePath

FilePathType

Screen recording file output path type. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public WritablePathType FilePathType

Orientation

Screen recording video orientation. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.VideoOrientation Orientation

VideoProfile

Video configuration. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.RecordProfile VideoProfile

ZoomMode

Screen recording scaling mode. Modifications are only effective before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.RecordZoomMode ZoomMode

Properties

IsAvailable

Whether screen recording is available (Only available in non-enterprise Sense, on Android GLES2/3 with multi-threaded rendering disabled).

public static bool IsAvailable { get; }

NotAvailableReason

Reason when unavailable.

public static string NotAvailableReason { get; }

Methods

RecordFrame(RenderTexture)

Records one frame of data using texture.

public void RecordFrame(RenderTexture texture)

Parameters

texture

StartRecording(Action<bool, PermissionStatus, string>, Action<string>)

Starts screen recording. Video data must be continuously passed in via RecordFrame(RenderTexture).

public void StartRecording(Action<bool, PermissionStatus, string> onStart, Action<string> onRecordError)

Parameters

onStart
onRecordError

StopRecording()

Stops screen recording.

public bool StopRecording()