Class RecorderSettings

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

Inheritance

System.Object

RecorderSettings

AnimationRecorderSettings

BaseFCRecorderSettings

ImageRecorderSettings

MovieRecorderSettings

Namespace: UnityEditor.Recorder

Syntax

public abstract class RecorderSettings : ScriptableObject

Constructors

RecorderSettings()

Declaration

protected RecorderSettings()

Fields

enabled

Used only when starting the recording. If false, this recorder will be ignored.

Declaration

public bool enabled

Field Value

Type	Description
System.Boolean

s_OutputFileErrorMessage

Declaration

public static string s_OutputFileErrorMessage

Field Value

Type	Description
System.String

take

Current Take number. Automatically incremented after each recording session.

Declaration

public int take

Field Value

Type	Description
System.Int32

Properties

extension

The extension used by this recorder without the dot.

Declaration

public abstract string extension { get; }

Property Value

Type	Description
System.String

inputsSettings

List of Input settings required by this recorder.

Declaration

public abstract IEnumerable<RecorderInputSettings> inputsSettings { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<RecorderInputSettings>

isPlatformSupported

Virtual method that can be used to return false if current platform is not supported.

Declaration

public virtual bool isPlatformSupported { get; }

Property Value

Type	Description
System.Boolean

outputFile

The output path this recorder will use to generate it's output file. File extension is automatically added. It can be either an absolute or relative path. Wildcards like DefaultWildcard.Time are supported. DefaultWildcard

Declaration

public string outputFile { get; set; }

Property Value

Type	Description
System.String

Methods

OnAfterDuplicate()

Override this method if any post treatement need to be done after a this recorder is duplicated in the RecorderWindow

Declaration

public virtual void OnAfterDuplicate()

SelfAdjustSettings()

Called each time a settings has changed in the RecorderWindow and before starting recording.

Declaration

public virtual void SelfAdjustSettings()