Class RecorderSettings

Main base class for a Recorder settings. Each Recorder needs to have its corresponding settings properly configured.

Inheritance
object
Object
ScriptableObject
RecorderSettings
AOVRecorderSettings
AnimationRecorderSettings
AudioRecorderSettings
BaseFCRecorderSettings
ImageRecorderSettings
MovieRecorderSettings
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetHashCode()
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
public abstract class RecorderSettings : ScriptableObject, ISerializationCallbackReceiver

Constructors

RecorderSettings()

The constructor of the class.

Declaration
protected RecorderSettings()

Properties

CapFrameRate

Specifies whether or not to limit the frame rate when it is above the target frame rate.

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

Enabled

Indicates if this Recorder is active when starting the recording. If false, the Recorder is ignored and generates no output.

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

EndFrame

The end frame of the recording.

Declaration
public int EndFrame { get; set; }
Property Value
Type Description
int

EndTime

The end time of the recording.

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

Extension

Stores the file extension used by this Recorder (without the dot).

Declaration
protected abstract string Extension { get; }
Property Value
Type Description
string

FileNameGenerator

The object that resolves wildcards into a final path for output files.

Declaration
public FileNameGenerator FileNameGenerator { get; }
Property Value
Type Description
FileNameGenerator

FrameRate

The number of recorded frames per second. In constant frame rate mode, this represent a target value, while in variable frame rate mode, this represents a maximum value.

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

FrameRatePlayback

The type of frame rate to use in the recording: constant or variable.

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

InputsSettings

Stores the list of Input settings required by this Recorder.

Declaration
public abstract IEnumerable<RecorderInputSettings> InputsSettings { get; }
Property Value
Type Description
IEnumerable<RecorderInputSettings>

IsPlatformSupported

Indicates if the current platform is supported (True) or not (False).

Declaration
public virtual bool IsPlatformSupported { get; }
Property Value
Type Description
bool

LatestVersion

Indicates the latest version of the recorder. This is used during the asset upgrade process to determine if the asset needs to be upgraded. Derived classes should override this property to provide their own latest version.

Declaration
protected virtual int LatestVersion { get; }
Property Value
Type Description
int

OutputFile

Stores the path this Recorder will use to generate the output file. It can be either an absolute or a relative path. The file extension is automatically added. Wildcards such as DefaultWildcard.Time are supported. DefaultWildcard

Declaration
public string OutputFile { get; set; }
Property Value
Type Description
string

RecordMode

The mode that defines the way to manage the starting point and duration of the recording: either manually or within a specific time or frame interval.

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

StartFrame

The start frame of the recording.

Declaration
public int StartFrame { get; set; }
Property Value
Type Description
int

StartTime

The start time of the recording.

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

Take

Stores the current Take number. Automatically incremented after each recording session.

Declaration
public int Take { get; set; }
Property Value
Type Description
int

Version

Indicates the current version of this recorder. This is used during the asset upgrade process to determine if the asset needs to be upgraded. Derived classes should override this property to provide their own version.

Declaration
protected virtual int Version { get; set; }
Property Value
Type Description
int

Methods

GetErrors(List<string>)

Tests if the Recorder has any errors.

Declaration
protected virtual void GetErrors(List<string> errors)
Parameters
Type Name Description
List<string> errors

List of errors encountered.

GetWarnings(List<string>)

Tests if the Recorder has any warnings.

Declaration
protected virtual void GetWarnings(List<string> warnings)
Parameters
Type Name Description
List<string> warnings

List of warnings encountered.

HasErrors()

Declaration
protected virtual bool HasErrors()
Returns
Type Description
bool

IsAccumulationSupported()

Indicates whether the current Recorder supports Accumulation recording or not.

Declaration
public virtual bool IsAccumulationSupported()
Returns
Type Description
bool

True if the current Recorder supports Accumulation recording, False otherwise.

OnAfterDeserialize()

Called after a RecorderSetting has been deserialized.

Declaration
protected virtual void OnAfterDeserialize()

OnAfterDuplicate()

Override this method if any post treatment needs to be done after this Recorder is duplicated in the Recorder Window.

Declaration
public virtual void OnAfterDuplicate()

OnBeforeSerialize()

Called before a RecorderSetting is serialized.

Declaration
protected virtual void OnBeforeSerialize()

OnUpgradeFromVersion()

Defines how to handle the upgrade of Recorder Settings created in a previous version according to their type. Unity automatically calls this method when loading a Recorder Setting (after deserialization) if its version is older than the current project version.

Declaration
protected virtual void OnUpgradeFromVersion()

ValidityCheck(List<string>)

Tests if the Recorder is correctly configured.

Declaration
[Obsolete("Please use methods GetErrors() and GetWarnings()")]
protected virtual bool ValidityCheck(List<string> errors)
Parameters
Type Name Description
List<string> errors

List of errors encountered.
Returns
Type Description
bool

True if there are no errors, False otherwise.

Implements