Class RecorderSettings
Main base class for a Recorder settings.
Each Recorder needs to have its corresponding settings properly configured.
Inheritance
RecorderSettings
Syntax
public abstract class RecorderSettings : ScriptableObject
Constructors
RecorderSettings()
Declaration
protected RecorderSettings()
Properties
CapFrameRate
Declaration
public bool CapFrameRate { get; set; }
Property Value
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
EndFrame
Declaration
public int EndFrame { get; set; }
Property Value
EndTime
Declaration
public float EndTime { get; set; }
Property Value
Extension
Stores the file extension used by this Recorder (without the dot).
Declaration
protected abstract string Extension { get; }
Property Value
FileNameGenerator
Declaration
public FileNameGenerator FileNameGenerator { get; }
Property Value
FrameRate
Declaration
public float FrameRate { get; set; }
Property Value
FrameRatePlayback
Declaration
public FrameRatePlayback FrameRatePlayback { get; set; }
Property Value
Stores the list of Input settings required by this Recorder.
Declaration
public abstract IEnumerable<RecorderInputSettings> InputsSettings { get; }
Property Value
Indicates if the current platform is supported (True) or not (False).
Declaration
public virtual bool IsPlatformSupported { get; }
Property Value
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
RecordMode
Declaration
public RecordMode RecordMode { get; set; }
Property Value
StartFrame
Declaration
public int StartFrame { get; set; }
Property Value
StartTime
Declaration
public float StartTime { get; set; }
Property Value
Take
Stores the current Take number. Automatically incremented after each recording session.
Declaration
public int Take { get; set; }
Property Value
Methods
HasErrors()
Declaration
protected virtual bool HasErrors()
Returns
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.
|