Class MovieRecorderSettings

A class that represents the settings of a Movie Recorder.

Inheritance
Object
RecorderSettings
MovieRecorderSettings
Inherited Members
Namespace: UnityEditor.Recorder
Syntax
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
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
Boolean
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
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
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
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
Implements

GetPresetsForEncoder(Int32, 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
Int32 indexEncoder

The index of the encoder to query
List<String> presetNames

The list of preset names
List<String> presetOptions

The list of preset options

IsAccumulationSupported()

Indicates whether the current Recorder supports Accumulation recording or not.

Declaration
public override bool IsAccumulationSupported()
Returns
Type Description
Boolean
Overrides

ValidityCheck(List<String>)

Tests if the Recorder is correctly configured.

Declaration
protected override 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.
Overrides