Interface ITakeRecorder
Represents a take recorder.
Namespace: Unity.LiveCapture
Syntax
public interface ITakeRecorderProperties
FrameRate
The frame rate to use for recording.
Declaration
FrameRate FrameRate { get; set; }Property Value
| Type | Description |
|---|---|
| FrameRate |
Shot
The current IShot to record to.
Declaration
IShot Shot { get; }Property Value
| Type | Description |
|---|---|
| IShot |
Methods
GetPreviewDuration()
Returns the current playback duration of the selected take.
Declaration
double GetPreviewDuration()Returns
| Type | Description |
|---|---|
| Double | The current duration in seconds. |
GetPreviewTime()
Returns the current playback time of the selected take.
Declaration
double GetPreviewTime()Returns
| Type | Description |
|---|---|
| Double | The current time in seconds. |
GetRecordingElapsedTime()
Returns the time elapsed since the start of the recording.
Declaration
double GetRecordingElapsedTime()Returns
| Type | Description |
|---|---|
| Double | The time elapsed since the start of the recording, in seconds. |
IsLive()
Indicates whether the take recorder is ready for recording.
Declaration
bool IsLive()Returns
| Type | Description |
|---|---|
| Boolean | true if ready for recording; otherwise, false. |
IsPreviewPlaying()
Checks whether the take recorder is playing the selected take or not.
Declaration
bool IsPreviewPlaying()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
IsRecording()
Checks whether the take recorder is recording or not.
Declaration
bool IsRecording()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
PausePreview()
Pauses the playback of the selected take.
Declaration
void PausePreview()PlayPreview()
Starts playing the selected take.
Declaration
void PlayPreview()SetLive(Boolean)
Use this method to set the take recorder ready for recording.
Declaration
void SetLive(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | value | true to set ready; otherwise, false. |
SetPreviewTime(Double)
Changes the current playback time of the selected take.
Declaration
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
void StartRecording()StopRecording()
Stops the recording.
Declaration
void StopRecording()