Class RecorderController

Main class to use the Recorder framework via script. Controls recording states like start and stop.

Inheritance
object
RecorderController
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: UnityEditor.Recorder
Assembly: solution.dll
Syntax
public class RecorderController

Constructors

Name Description
RecorderController(RecorderControllerSettings)

The constructor of the RecorderController.

Properties

Name Description
Settings

Current settings used by this RecorderControler.

Methods

Name Description
IsRecording()

Use this method to know if all recorders are done recording. A recording stops:

  1. The settings is set to a time (or frame) interval and the end time (or last frame) was reached.
  2. Calling the StopRecording method.
  3. Exiting Playmode.
PrepareRecording()

Prepares the recording context. To start recording once you've called this method, you must call StartRecording().
StartRecording()

Starts the recording (works only in Play mode). To use this method, you must first have called PrepareRecording() to set up the recording context. Also ensure that you've finished loading any additional Scene data required before you start recording.
StopRecording()

Stops all active recordings. Most recordings will create the recorded file once stopped. If the settings is using Manual recording mode. then the only way to stop recording is by calling this method or by exiting Playmode.

Did you find this page useful? Please give it a rating: