Class RecorderSettings

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

Inheritance

Object

Object

ScriptableObject

RecorderSettings

AnimationRecorderSettings

BaseFCRecorderSettings

ImageRecorderSettings

MovieRecorderSettings

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, Boolean)

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, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: UnityEditor.Recorder

Syntax

public abstract class RecorderSettings : ScriptableObject

Constructors

RecorderSettings()

Declaration

protected RecorderSettings()

Properties

CapFrameRate

Declaration

public bool CapFrameRate { get; set; }

Property Value

Type	Description
Boolean

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
Boolean

EndFrame

Declaration

public int EndFrame { get; set; }

Property Value

Type	Description
Int32

EndTime

Declaration

public float EndTime { get; set; }

Property Value

Type	Description
Single

Extension

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

Declaration

protected abstract string Extension { get; }

Property Value

Type	Description
String

FileNameGenerator

Declaration

public FileNameGenerator FileNameGenerator { get; }

Property Value

Type	Description
FileNameGenerator

FrameRate

Declaration

public float FrameRate { get; set; }

Property Value

Type	Description
Single

FrameRatePlayback

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
Boolean

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

Declaration

public RecordMode RecordMode { get; set; }

Property Value

Type	Description
RecordMode

StartFrame

Declaration

public int StartFrame { get; set; }

Property Value

Type	Description
Int32

StartTime

Declaration

public float StartTime { get; set; }

Property Value

Type	Description
Single

Take

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

Declaration

public int Take { get; set; }

Property Value

Type	Description
Int32

Methods

HasErrors()

Declaration

protected virtual bool HasErrors()

Returns

Type	Description
Boolean

OnAfterDuplicate()

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

Declaration

public virtual void OnAfterDuplicate()

ValidityCheck(List<String>)

Tests if the Recorder is correctly configured.

Declaration

protected virtual bool ValidityCheck(List<string> errors)

Parameters

Type	Name	Description
List<String>	errors	List of errors encountered.

Returns

Type	Description
Boolean	True if there are no errors, False otherwise.