docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RecorderSettings

    Main base class for a Recorder settings. Each Recorder needs to have its corresponding settings properly configured.

    Inheritance
    object
    Object
    ScriptableObject
    RecorderSettings
    AnimationRecorderSettings
    AudioRecorderSettings
    BaseFCRecorderSettings
    ImageRecorderSettings
    MovieRecorderSettings
    Implements
    ISerializationCallbackReceiver
    Inherited Members
    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.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: UnityEditor.Recorder
    Assembly: solution.dll
    Syntax
    public abstract class RecorderSettings : ScriptableObject, ISerializationCallbackReceiver

    Constructors

    Name Description
    RecorderSettings()

    The constructor of the class.

    Properties

    Name Description
    CapFrameRate

    Specifies whether or not to limit the frame rate when it is above the target frame rate.

    Enabled

    Indicates if this Recorder is active when starting the recording. If false, the Recorder is ignored and generates no output.

    EndFrame

    The end frame of the recording.

    EndTime

    The end time of the recording.

    Extension

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

    FileNameGenerator

    The object that resolves wildcards into a final path for output files.

    FrameRate

    The number of recorded frames per second. In constant frame rate mode, this represent a target value, while in variable frame rate mode, this represents a maximum value.

    FrameRatePlayback

    The type of frame rate to use in the recording: constant or variable.

    InputsSettings

    Stores the list of Input settings required by this Recorder.

    IsPlatformSupported

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

    OutputFile

    Stores the path this Recorder will use to generate the output file. It can be either an absolute or a relative path. The file extension is automatically added. Wildcards such as DefaultWildcard.Time are supported. DefaultWildcard

    RecordMode

    The mode that defines the way to manage the starting point and duration of the recording: either manually or within a specific time or frame interval.

    StartFrame

    The start frame of the recording.

    StartTime

    The start time of the recording.

    Take

    Stores the current Take number. Automatically incremented after each recording session.

    Methods

    Name Description
    GetErrors(List<string>)

    Tests if the Recorder has any errors.

    GetWarnings(List<string>)

    Tests if the Recorder has any warnings.

    HasErrors()
    IsAccumulationSupported()

    Indicates whether the current Recorder supports Accumulation recording or not.

    OnAfterDeserialize()

    Called after a RecorderSetting has been deserialized.

    OnAfterDuplicate()

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

    OnBeforeSerialize()

    Called before a RecorderSetting is serialized.

    ValidityCheck(List<string>)

    Tests if the Recorder is correctly configured.

    In This Article
    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