Class TakeRecorder
A take recorder that manages a set of capture devices.
Namespace: Unity.LiveCapture
Syntax
public static class TakeRecorderProperties
FrameRate
The frame rate to use for recording.
Declaration
public static FrameRate FrameRate { get; set; }Property Value
| Type | Description |
|---|---|
| FrameRate |
IsLive
Indicates whether the take recorder is ready for recording.
Declaration
public static bool IsLive { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
PlayTakeContents
Indicates whether or not to play the entire shot or just the range where the Take contains recorded data.
Declaration
public static bool PlayTakeContents { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Shot
The current Shot to record to.
Declaration
public static Shot? Shot { get; }Property Value
| Type | Description |
|---|---|
| Nullable<Shot> |
Methods
GetPreviewDuration()
Returns the current playback duration of the selected take.
Declaration
public static double GetPreviewDuration()Returns
| Type | Description |
|---|---|
| Double | The current duration in seconds. |
GetPreviewTime()
Returns the current playback time of the selected take.
Declaration
public static double GetPreviewTime()Returns
| Type | Description |
|---|---|
| Double | The current time in seconds. |
GetRecordingElapsedTime()
Returns the time elapsed since the start of the recording.
Declaration
public static double GetRecordingElapsedTime()Returns
| Type | Description |
|---|---|
| Double | The time elapsed since the start of the recording, in seconds. |
IsPreviewPlaying()
Checks whether the take recorder is playing the selected take or not.
Declaration
public static bool IsPreviewPlaying()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
IsRecording()
Checks whether the take recorder is recording or not.
Declaration
public static bool IsRecording()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
PausePreview()
Pauses the playback of the selected take.
Declaration
public static void PausePreview()PlayPreview()
Starts playing the selected take.
Declaration
public static void PlayPreview()SetPreviewTime(Double)
Changes the current playback time of the selected take.
Declaration
public static void SetPreviewTime(double time)Parameters
| Type | Name | Description |
|---|---|---|
| Double | time | The current time in seconds. |
StartRecording()
Starts the recording of a new take for the selected slate.
Declaration
public static void StartRecording()StopRecording()
Stops the recording.
Declaration
public static void StopRecording()Events
LiveStateChanged
TakeRecorder executes this event when live mode has been enabled or disabled.
Declaration
public static event Action LiveStateChangedEvent Type
| Type | Description |
|---|---|
| Action |
PlaybackStateChanged
TakeRecorder executes this event when playback has started or stopped.
Declaration
public static event Action PlaybackStateChangedEvent Type
| Type | Description |
|---|---|
| Action |
RecordingStateChanged
TakeRecorder executes this event when recording has started or stopped.
Declaration
public static event Action RecordingStateChangedEvent Type
| Type | Description |
|---|---|
| Action |