Class RecorderController

Main class to use the Recorder framework via script. Controls recording states like start and stop.

Inheritance
System.Object
RecorderController
Namespace: UnityEditor.Recorder
Syntax
public class RecorderController

Constructors

RecorderController(RecorderControllerSettings)

A RecorderController requires a RecorderControllerSettings.

Declaration
public RecorderController(RecorderControllerSettings settings)
Parameters
Type Name Description
RecorderControllerSettings settings

The RecorderControllerSettings to be used by this RecorderController.

Properties

settings

Current settings used by this RecorderControler.

Declaration
public RecorderControllerSettings settings { get; }
Property Value
Type Description
RecorderControllerSettings

Methods

IsRecording()

Use this method to know if all recorders are done recording. A recording stops:

  1. The settings is set to a time (or frame) interval and the end time (or last frame) was reached.
  2. Calling the StopRecording method.
  3. Exiting Playmode.
Declaration
public bool IsRecording()
Returns
Type Description
System.Boolean

True if at least one recording is still active. false otherwise.
See Also

StartRecording()

Start recording. Works only in Playmode.

Declaration
public bool StartRecording()
Returns
Type Description
System.Boolean

false if an error occured. The console will usually contains logs about the errors.
Exceptions
Type Condition
System.Exception

If not in Playmode.
System.NullReferenceException

If settings is null.

StopRecording()

Stops all active recordings. Most recordings will create the recorded file once stopped. If the settings is using Manual recording mode. then the only way to stop recording is by calling this method or by exiting Playmode.

Declaration
public void StopRecording()
See Also