Table of Contents

Class VideoRecorder

Namespace
easyar
Assembly
EasyAR.Sense.dll

A MonoBehaviour that controls Recorder in the scene and provides functional extensions in the Unity environment.

Users have full control over the content recorded in the video. The screen recording feature does not silently record the screen or camera output; recorded video data must be continuously passed in through RecordFrame(RenderTexture).

Note: Available only in non-Enterprise Sense on Android GLES2/3 with multithreaded rendering disabled.

public class VideoRecorder : MonoBehaviour
Inheritance
VideoRecorder

Fields

AudioProfile

Audio configuration. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.AudioProfiles AudioProfile

CustomVideoProfile

Custom screen recording configuration. Used when VideoProfile == Custom. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.VideoProfiles CustomVideoProfile

FilePath

Screen recording file output path. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public string FilePath

FilePathType

Screen recording file output path type. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public WritablePathType FilePathType

Orientation

Screen recording video orientation. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.VideoOrientation Orientation

VideoProfile

Video configuration. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.RecordProfile VideoProfile

ZoomMode

Screen recording scale mode. Changes take effect only before StartRecording(Action<bool, PermissionStatus, string>, Action<string>).

public VideoRecorder.RecordZoomMode ZoomMode

Properties

IsAvailable

Whether the screen recording feature is available (available only in non-Enterprise Sense on Android GLES2/3 with multithreaded rendering disabled).

public static bool IsAvailable { get; }

NotAvailableReason

The reason when it is 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. Recorded video data must be continuously passed in through RecordFrame(RenderTexture).

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

Parameters

onStart
onRecordError

StopRecording()

Stops screen recording.

public bool StopRecording()