Class MovieRecorderSettings
A class that represents the settings of a Movie Recorder.
Inherited Members
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
[RecorderSettings(typeof(MovieRecorder), "Movie", "movie_16")]
public class MovieRecorderSettings : RecorderSettings, ISerializationCallbackReceiver, IAccumulationConstructors
MovieRecorderSettings()
Default constructor.
Declaration
public MovieRecorderSettings()Properties
AccumulationSettings
Stores the AccumulationSettings properties.
Declaration
public AccumulationSettings AccumulationSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AccumulationSettings |
AudioInputSettings
Indicates the Audio Input Settings currently used for this Recorder.
Declaration
public AudioInputSettings AudioInputSettings { get; }Property Value
| Type | Description |
|---|---|
| AudioInputSettings |
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.
CaptureAudio
Use this property to capture the audio signal (True) or not (False) in the output.
Declaration
public bool CaptureAudio { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
The audio signal will be captured only if the output format supports it.
EncoderSettings
Use this property to define the encoder used by the Recorder.
Declaration
public IEncoderSettings EncoderSettings { get; set; }Property Value
| Type | Description |
|---|---|
| IEncoderSettings |
EncodingQuality
Indicates the encoding quality to use for this Recorder.
Declaration
[Obsolete("Please use the EncoderSettings API to set/get the bitrate/encoding quality of each Encoder.")]
public MovieRecorderSettings.VideoEncodingQuality EncodingQuality { get; set; }Property Value
| Type | Description |
|---|---|
| MovieRecorderSettings.VideoEncodingQuality |
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 |
|---|---|
| ImageInputSettings |
InputsSettings
Stores the list of Input settings required by this Recorder.
Declaration
public override IEnumerable<RecorderInputSettings> InputsSettings { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<RecorderInputSettings> |
Overrides
OutputFormat
Indicates the output video format currently used for this Recorder.
Declaration
[Obsolete("Please use the EncoderSettings API to set/get the format/codec of each Encoder.")]
public MovieRecorderSettings.VideoRecorderOutputFormat OutputFormat { get; set; }Property Value
| Type | Description |
|---|---|
| MovieRecorderSettings.VideoRecorderOutputFormat |
VideoBitRateMode
Indicates the video bit rate preset currently used for this Recorder.
Declaration
[Obsolete("Please use the EncoderSettings API to set/get the bitrate/encoding quality of each Encoder.")]
public VideoBitrateMode VideoBitRateMode { get; set; }Property Value
| Type | Description |
|---|---|
| VideoBitrateMode |
Methods
GetAccumulationSettings()
Use this method to get all the AccumulationSettings properties.
Declaration
public AccumulationSettings GetAccumulationSettings()Returns
| Type | Description |
|---|---|
| AccumulationSettings | AccumulationSettings |
GetErrors(List<string>)
Tests if the Recorder has any errors.
Declaration
protected override void GetErrors(List<string> errors)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | errors | List of errors encountered. |
Overrides
GetWarnings(List<string>)
Tests if the Recorder has any warnings.
Declaration
protected override void GetWarnings(List<string> warnings)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | warnings | List of warnings encountered. |
Overrides
HasErrors()
Declaration
protected override bool HasErrors()Returns
| Type | Description |
|---|---|
| bool |
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. |