Class MovieRecorderSettings
A class that represents the settings of a Movie Recorder.
Implements
Inherited Members
Namespace: UnityEditor .Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
[RecorderSettings(typeof(MovieRecorder), "Movie", "movie_16")]
public class MovieRecorderSettings : RecorderSettings, IAccumulation
Constructors
MovieRecorderSettings()
Default constructor.
Declaration
public MovieRecorderSettings()
Properties
AccumulationSettings
Stores the AccumulationSettings properties.
Declaration
public AccumulationSettings AccumulationSettings { get; set; }
Property Value
Type | Description |
---|---|
Accumulation |
AudioInputSettings
Indicates the Audio Input Settings currently used for this Recorder.
Declaration
public AudioInputSettings AudioInputSettings { get; }
Property Value
Type | Description |
---|---|
Audio |
CaptureAlpha
Use this property to capture the alpha channel (True) or not (False) in the output.
Declaration
public bool CaptureAlpha { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Alpha channel will be captured only if the output image format supports it.
Extension
Stores the file extension used by this Recorder (without the dot).
Declaration
protected override string Extension { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ImageInputSettings
Indicates the Image Input Settings currently used for this Recorder.
Declaration
public ImageInputSettings ImageInputSettings { get; set; }
Property Value
Type | Description |
---|---|
Image |
InputsSettings
Stores the list of Input settings required by this Recorder.
Declaration
public override IEnumerable<RecorderInputSettings> InputsSettings { get; }
Property Value
Type | Description |
---|---|
IEnumerable<Recorder |
Overrides
OutputFormat
Indicates the output video format currently used for this Recorder.
Declaration
public MovieRecorderSettings.VideoRecorderOutputFormat OutputFormat { get; set; }
Property Value
Type | Description |
---|---|
Movie |
VideoBitRateMode
Indicates the video bit rate preset currently used for this Recorder.
Declaration
public VideoBitrateMode VideoBitRateMode { get; set; }
Property Value
Type | Description |
---|---|
Video |
Methods
GetAccumulationSettings()
Use this method to get all the AccumulationSettings properties.
Declaration
public AccumulationSettings GetAccumulationSettings()
Returns
Type | Description |
---|---|
Accumulation |
AccumulationSettings |
GetErrors(List<string>)
Tests if the Recorder has any errors.
Declaration
protected override void GetErrors(List<string> errors)
Parameters
Overrides
GetPresetsForEncoder(int, out List<string>, out List<string>)
Gets the preset names and options of the encoder at the specified index.
Declaration
public void GetPresetsForEncoder(int indexEncoder, out List<string> presetNames, out List<string> presetOptions)
Parameters
Type | Name | Description |
---|---|---|
int | indexEncoder | The index of the encoder to query |
List<string> | presetNames | The list of preset names |
List<string> | presetOptions | The list of preset options |
GetWarnings(List<string>)
Tests if the Recorder has any warnings.
Declaration
protected override void GetWarnings(List<string> warnings)
Parameters
Overrides
IsAccumulationSupported()
Indicates whether the current Recorder supports Accumulation recording or not.
Declaration
public override bool IsAccumulationSupported()
Returns
Type | Description |
---|---|
bool | True if the current Recorder supports Accumulation recording, False otherwise. |