docs.unity.cn
    Show / Hide Table of Contents

    Class RecorderWindow

    Main window class of the Unity Recorder. It can be accessed from an Editor script to show the Recorder Window and eventually Start and Stop the recording using current settings. Recorder settings are saved in Library/Recorder/recorder.pref

    Inheritance
    Object
    RecorderWindow
    Namespace: UnityEditor.Recorder
    Syntax
    public class RecorderWindow : EditorWindow

    Fields

    MenuRoot

    The location in the Unity Editor menu for the Recorder Window.

    Declaration
    public const string MenuRoot = null
    Field Value
    Type Description
    String

    MenuRootIndex

    The priority of the Recorder Window entries in the menu.

    Declaration
    public const int MenuRootIndex = null
    Field Value
    Type Description
    Int32

    Methods

    ApplyPreset(RecorderControllerSettingsPreset)

    Loads a previously saved Recorder List.

    Declaration
    public void ApplyPreset(RecorderControllerSettingsPreset preset)
    Parameters
    Type Name Description
    RecorderControllerSettingsPreset preset

    The instance of Recorder List to load.

    IsRecording()

    Used to get the current state of the recording.

    Declaration
    public bool IsRecording()
    Returns
    Type Description
    Boolean

    True if the Recorder is started or being started. False otherwise.

    SetRecorderControllerSettings(RecorderControllerSettings)

    Set the RecorderWindow controller settings and update the UI. This allow to set settings even if the window is open.

    Declaration
    public void SetRecorderControllerSettings(RecorderControllerSettings settings)
    Parameters
    Type Name Description
    RecorderControllerSettings settings

    The new RecorderControllerSettings to set.

    StartRecording()

    Used to Start the recording with current settings. If not already the case, the Editor will also switch to PlayMode.

    Declaration
    public void StartRecording()

    StopRecording()

    Used to Stop current recordings if any. Exiting PlayMode while the Recorder is recording will automatically Stop the recorder.

    Declaration
    public void StopRecording()
    Back to top Copyright © 2021 Unity Technologies
    Generated by DocFX
    on Friday, November 5, 2021
    Terms of use