Class RecorderControllerSettings

Use this class to manage the recording settings (frame rate, frame range, list of Recorder Settings) for the RecorderController.

Inheritance
object
Object
ScriptableObject
RecorderControllerSettings
Inherited Members
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
public class RecorderControllerSettings : ScriptableObject

Properties

CapFrameRate

Indicates if the Recorders frame rate should cap the Unity rendering frame rate. When enabled, Unity is prevented from rendering faster than the set FrameRate.

Declaration
public bool CapFrameRate { get; set; }
Property Value
Type Description
bool

ExitPlayMode

Instructs the recorder to exit Play Mode once the recording has finished.

Declaration
public bool ExitPlayMode { get; set; }
Property Value
Type Description
bool

FrameRate

Allows setting and retrieving the frame rate for the current list of Recorders.

Declaration
public float FrameRate { get; set; }
Property Value
Type Description
float

FrameRatePlayback

Indicates the type of frame rate (constant or variable) for the current list of Recorders.

Declaration
public FrameRatePlayback FrameRatePlayback { get; set; }
Property Value
Type Description
FrameRatePlayback

RecorderSettings

Stores the collection of Recorder Settings instances.

Declaration
public IEnumerable<RecorderSettings> RecorderSettings { get; }
Property Value
Type Description
IEnumerable<RecorderSettings>

Methods

AddRecorderSettings(RecorderSettings)

Adds a new instance of Recorder Settings to the current collection.

Declaration
public void AddRecorderSettings(RecorderSettings recorder)
Parameters
Type Name Description
RecorderSettings recorder

The Recorder Settings instance to add.

GetGlobalSettings()

Get the global controller settings.

Declaration
public static RecorderControllerSettings GetGlobalSettings()
Returns
Type Description
RecorderControllerSettings

The global RecorderControllerSettings

LoadOrCreate(string)

Loads or creates Recorder Settings to the specified file path.

Declaration
public static RecorderControllerSettings LoadOrCreate(string path)
Parameters
Type Name Description
string path

The path to load or create Recorder Settings.
Returns
Type Description
RecorderControllerSettings

The loaded or created Recorder Settings.

RemoveRecorder(RecorderSettings)

Removes an instance of Recorder Settings from the current collection.

Declaration
public void RemoveRecorder(RecorderSettings recorder)
Parameters
Type Name Description
RecorderSettings recorder

The Recorder settings instance to be removed.

Save()

Saves the current list of Recorder Settings instances to disk.

Declaration
public void Save()

SetRecordModeToFrameInterval(int, int)

Sets the Recorders to Frame Interval mode and defines the Start and End frame of the interval to record.

Declaration
public void SetRecordModeToFrameInterval(int startFrame, int endFrame)
Parameters
Type Name Description
int startFrame

Start frame.
int endFrame

End frame.

SetRecordModeToManual()

Sets the Recorders to Manual mode.

Declaration
public void SetRecordModeToManual()

SetRecordModeToSingleFrame(int)

Sets the Recorders to Single Frame recording mode.

Declaration
public void SetRecordModeToSingleFrame(int frameNumber)
Parameters
Type Name Description
int frameNumber

The frame to be recorded.

SetRecordModeToTimeInterval(float, float)

Sets the Recorders to Time Interval mode and defines the Start and End times of the interval to record.

Declaration
public void SetRecordModeToTimeInterval(float startTime, float endTime)
Parameters
Type Name Description
float startTime

The start time, in seconds.
float endTime

The end time, in seconds.