Class RecorderWindow
Main window class of the 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
Inherited Members
Namespace: UnityEditor.Recorder
Assembly: Unity.Recorder.Editor.dll
Syntax
public class RecorderWindow : EditorWindow
Fields
MenuRoot
The location in the Unity Editor menu for the Recorder Window.
Declaration
public const string MenuRoot = "Window/General/Recorder/"
Field Value
Type | Description |
---|---|
string |
MenuRootIndex
The priority of the Recorder Window entries in the menu.
Declaration
public const int MenuRootIndex = 1000
Field Value
Type | Description |
---|---|
int |
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 |
---|---|
bool | 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()