VideoRecorder Class¶

Description¶

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

You have full control of what is recorded. The recorder do not record the screen or the camera output silently, the video data being recorded should be passed in continuously using VideoRecorder.RecordFrame

NOTE: Video recording feature do not work on iOS when using Unity 2020.2 or later.

Enums¶

public enum VideoRecorder.VideoOrientation

Record video orientation.

MonoBehaviour Messages¶

private void Start()

private void OnDestroy()

Fields¶

Profile¶

C#: public RecordProfile Profile

Record profile used only when create.

Orientation¶

C#: public VideoRecorder.VideoOrientation Orientation

Record video orientation used only when create.

RecordZoomMode¶

C#: public RecordZoomMode RecordZoomMode

Record zoom mode used only when create.

FilePathType¶

C#: public WritablePathType FilePathType

Record output file path type used only when create.

FilePath¶

C#: public string FilePath

Record output file path used only when create.

Properties¶

IsReady¶

C#: public bool IsReady { get; }

The recorder can be used. Recorder cannot work if permission not granted.

Events¶

StatusUpdate¶

C#: public event Action< RecordStatus , string> StatusUpdate

Event when record status changes.

Methods¶

StartRecording¶

C#: public bool StartRecording()

Start recording using configuration set in the component. The video data being recorded should be passed in continuously using VideoRecorder.RecordFrame 。

StartRecording¶

C#: public bool StartRecording( RecorderConfiguration configuration)

Start recording using configuration . The configuration set in the component will be ignored. The video data being recorded should be passed in continuously using VideoRecorder.RecordFrame

StopRecording¶

C#: public bool StopRecording()

Stop recording.

RecordFrame¶

C#: public bool RecordFrame( RenderTexture texture)

Record a frame using texture .