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

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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.