Class RecorderControllerSettings
Use this class to manage the recording settings (frame rate, frame range, list of Recorder Settings) for the RecorderController.
Namespace: UnityEditor.Recorder
Syntax
public class RecorderControllerSettings : ScriptableObjectProperties
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 |
|---|---|
| Boolean |
FrameRate
Allows setting and retrieving the frame rate for the current list of Recorders.
Declaration
public float FrameRate { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
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(Int32, Int32)
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 |
|---|---|---|
| Int32 | startFrame | Start frame. |
| Int32 | endFrame | End frame. |
SetRecordModeToManual()
Sets the Recorders to Manual mode.
Declaration
public void SetRecordModeToManual()SetRecordModeToSingleFrame(Int32)
Sets the Recorders to Single Frame recording mode.
Declaration
public void SetRecordModeToSingleFrame(int frameNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | frameNumber | The frame to be recorded. |
SetRecordModeToTimeInterval(Single, Single)
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 |
|---|---|---|
| Single | startTime | Start time. |
| Single | endTime | End time. |