Class AnimationRecorderSettings | Unity Recorder | 2.1.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class AnimationRecorderSettings

    Class describing the settings for Animation Recorder.

    Inheritance
    Object
    RecorderSettings
    AnimationRecorderSettings
    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.HasErrors()
    Namespace: UnityEditor.Recorder
    Syntax
    [Serializable]
    [RecorderSettings(typeof(AnimationRecorder), "Animation Clip", "animation_recorder")]
    public class AnimationRecorderSettings : RecorderSettings

    Constructors

    AnimationRecorderSettings()

    Default constructor.

    Declaration
    public AnimationRecorderSettings()

    Properties

    AnimationInputSettings

    Stores the reference to the current Animation Recorder input settings.

    Declaration
    public AnimationInputSettings AnimationInputSettings { get; set; }
    Property Value
    Type Description
    AnimationInputSettings

    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

    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

    IsPlatformSupported

    Indicates if the current platform is supported (True) or not (False).

    Declaration
    public override bool IsPlatformSupported { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    RecorderSettings.IsPlatformSupported
    Remarks

    Animation Recorder currently supports the following platforms: LinuxEditor, OSXEditor, WindowsEditor.

    Methods

    OnAfterDuplicate()

    Override this method if any post treatement needs to be done after this Recorder is duplicated in the Recorder Window.

    Declaration
    public override void OnAfterDuplicate()
    Overrides
    RecorderSettings.OnAfterDuplicate()

    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
    RecorderSettings.ValidityCheck(List<String>)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023