docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class MovieRecorderSettings

    A class that represents the settings of a Movie Recorder.

    Inheritance
    object
    Object
    ScriptableObject
    RecorderSettings
    MovieRecorderSettings
    Implements
    IAccumulation
    Inherited Members
    RecorderSettings.OutputFile
    RecorderSettings.Enabled
    RecorderSettings.Take
    RecorderSettings.FileNameGenerator
    RecorderSettings.RecordMode
    RecorderSettings.FrameRatePlayback
    RecorderSettings.FrameRate
    RecorderSettings.StartFrame
    RecorderSettings.EndFrame
    RecorderSettings.StartTime
    RecorderSettings.EndTime
    RecorderSettings.CapFrameRate
    RecorderSettings.ValidityCheck(List<string>)
    RecorderSettings.IsPlatformSupported
    RecorderSettings.OnAfterDuplicate()
    RecorderSettings.HasErrors()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    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
    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.

    Extension

    Stores the file extension used by this Recorder (without the dot).

    Declaration
    protected override string Extension { get; }
    Property Value
    Type Description
    string
    Overrides
    RecorderSettings.Extension

    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
    RecorderSettings.InputsSettings

    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

    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
    RecorderSettings.GetErrors(List<string>)

    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
    Type Name Description
    List<string> warnings

    List of warnings encountered.

    Overrides
    RecorderSettings.GetWarnings(List<string>)

    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.

    Overrides
    RecorderSettings.IsAccumulationSupported()

    Implements

    IAccumulation
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)