Class TakeRecorder
A take recorder that manages a set of capture devices.
Implements
Inherited Members
Namespace: Unity.LiveCapture
Assembly: Unity.LiveCapture.dll
Syntax
[ExecuteAlways]
[DefaultExecutionOrder(-10)]
[DisallowMultipleComponent]
[ExcludeFromPreset]
[RequireComponent(typeof(PlayableDirector))]
[AddComponentMenu("Live Capture/Take Recorder")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@1.0/manual/ref-component-take-recorder.html")]
public class TakeRecorder : MonoBehaviour, ITakeRecorder
Remarks
This class provides the devices with the PlayableDirector's playable graph, to allow them to modify the animation stream and make actors in the scene go live.
Properties
FrameRate
The frame rate to use for recording.
Declaration
public FrameRate FrameRate { get; set; }
Property Value
| Type | Description |
|---|---|
| FrameRate |
Methods
GetActiveSlate()
The selected slate to use for recording.
Declaration
public ISlate GetActiveSlate()
Returns
| Type | Description |
|---|---|
| ISlate | The selected slate. |
GetPreviewTime()
Returns the current playback time of the selected take.
Declaration
public double GetPreviewTime()
Returns
| Type | Description |
|---|---|
| double | The current time in seconds. |
IsLive()
Indicates whether the take recorder is ready for recording.
Declaration
public bool IsLive()
Returns
| Type | Description |
|---|---|
| bool | true if ready for recording; otherwise, false. |
IsPreviewPlaying()
Checks whether the take recorder is playing the selected take or not.
Declaration
public bool IsPreviewPlaying()
Returns
| Type | Description |
|---|---|
| bool | true if playing; otherwise, false. |
IsRecording()
Checks whether the take recorder is recording or not.
Declaration
public bool IsRecording()
Returns
| Type | Description |
|---|---|
| bool | true if playing; otherwise, false. |
PausePreview()
Pauses the playback of the selected take.
Declaration
public void PausePreview()
PlayPreview()
Starts playing the selected take.
Declaration
public void PlayPreview()
Rebuild()
Rebuilds the PlayableGraph and prepares the devices.
Declaration
public void Rebuild()
SetLive(bool)
Use this method to set the take recorder ready for recording.
Declaration
public void SetLive(bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | value | true to set ready; otherwise, false. |
SetPreviewTime(double)
Changes the current playback time of the selected take.
Declaration
public 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 void StartRecording()
StopRecording()
Stops the recording.
Declaration
public void StopRecording()