Class RecorderSettings
Main base class for a Recorder settings. Each Recorder needs to have its corresponding settings properly configured.
Implements
Inherited Members
Namespace: UnityEditor.Recorder
Assembly: solution.dll
Syntax
public abstract class RecorderSettings : ScriptableObject, ISerializationCallbackReceiver
Constructors
| Name | Description |
|---|---|
| RecorderSettings() | The constructor of the class. |
Properties
| Name | Description |
|---|---|
| CapFrameRate | Specifies whether or not to limit the frame rate when it is above the target frame rate. |
| Enabled | Indicates if this Recorder is active when starting the recording. If false, the Recorder is ignored and generates no output. |
| EndFrame | The end frame of the recording. |
| EndTime | The end time of the recording. |
| Extension | Stores the file extension used by this Recorder (without the dot). |
| FileNameGenerator | The object that resolves wildcards into a final path for output files. |
| 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. |
| FrameRatePlayback | The type of frame rate to use in the recording: constant or variable. |
| InputsSettings | Stores the list of Input settings required by this Recorder. |
| IsPlatformSupported | Indicates if the current platform is supported (True) or not (False). |
| 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 |
| 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. |
| StartFrame | The start frame of the recording. |
| StartTime | The start time of the recording. |
| Take | Stores the current Take number. Automatically incremented after each recording session. |
Methods
| Name | Description |
|---|---|
| GetErrors(List<string>) | Tests if the Recorder has any errors. |
| GetWarnings(List<string>) | Tests if the Recorder has any warnings. |
| HasErrors() | |
| IsAccumulationSupported() | Indicates whether the current Recorder supports Accumulation recording or not. |
| OnAfterDeserialize() | Called after a RecorderSetting has been deserialized. |
| OnAfterDuplicate() | Override this method if any post treatment needs to be done after this Recorder is duplicated in the Recorder Window. |
| OnBeforeSerialize() | Called before a RecorderSetting is serialized. |
| ValidityCheck(List<string>) | Tests if the Recorder is correctly configured. |