Class Recorder
Base class for all Recorders. To create a new Recorder, extend GenericRecorder<T>.
Namespace: UnityEditor.Recorder
Syntax
public abstract class Recorder : ScriptableObjectFields
m_Inputs
Declaration
protected List<RecorderInput> m_InputsField Value
| Type | Description |
|---|---|
| List<RecorderInput> |
Properties
RecordedFramesCount
Indicates the number of frames of the current recording session.
Declaration
protected int RecordedFramesCount { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Recording
Tests if there is a recording session currently running.
Declaration
public bool Recording { get; protected set; }Property Value
| Type | Description |
|---|---|
| Boolean | True if a recording session is currently active, False otherwise. |
Methods
BeginRecording(RecordingSession)
Starts a new recording session. Callback is invoked once when the recording session starts.
Declaration
protected virtual bool BeginRecording(RecordingSession session)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | session | The newly created recording session. |
Returns
| Type | Description |
|---|---|
| Boolean | True if recording can start, False otherwise. |
Exceptions
| Type | Condition |
|---|---|
| Exception | Throws if there is already a recording session running. |
EndRecording(RecordingSession)
Ends the current recording session. Callback is invoked when the recording session ends.
Declaration
protected virtual void EndRecording(RecordingSession session)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | session | The current recording session. |
PrepareNewFrame(RecordingSession)
Prepares a frame before recording it. Callback is invoked for every frame during the recording session, before RecordFrame.
Declaration
protected virtual void PrepareNewFrame(RecordingSession ctx)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | ctx | The current recording session. |
RecordFrame(RecordingSession)
Records a single frame. Callback is invoked for every frame during the recording session.
Declaration
protected abstract void RecordFrame(RecordingSession ctx)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | ctx | The current recording session. |
Reset()
Declaration
protected virtual void Reset()SessionCreated(RecordingSession)
Declaration
protected virtual void SessionCreated(RecordingSession session)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | session |
SkipFrame(RecordingSession)
Tests if a frame should be skipped before trying to record it. Callback is invoked for every frame during the recording session.
Declaration
protected virtual bool SkipFrame(RecordingSession ctx)Parameters
| Type | Name | Description |
|---|---|---|
| RecordingSession | ctx | The current recording session. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the frame should be skipped, False otherwise. |
Remarks
If this function returns True, RecordFrame will not be invoked.