Class TakeRecorder
A take recorder that manages a set of capture devices.
Inherited Members
Namespace: Unity.LiveCapture
Syntax
[ExecuteAlways]
[DefaultExecutionOrder(-10)]
[DisallowMultipleComponent]
[ExcludeFromPreset]
[RequireComponent(typeof(PlayableDirector))]
[AddComponentMenu("Live Capture/Take Recorder")]
[HelpURL("https://docs.unity.cn/Packages/com.unity.live-capture@1.1/manual/ref-component-take-recorder.html")]
public class TakeRecorder : MonoBehaviour, ITakeRecorderInternal, ITakeRecorderRemarks
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 |
Implements
Methods
GetActiveSlate()
The selected slate to use for recording.
Declaration
public ISlate GetActiveSlate()Returns
| Type | Description |
|---|---|
| ISlate | The selected slate. |
Implements
GetPreviewTime()
Returns the current playback time of the selected take.
Declaration
public double GetPreviewTime()Returns
| Type | Description |
|---|---|
| Double | The current time in seconds. |
Implements
IsLive()
Indicates whether the take recorder is ready for recording.
Declaration
public bool IsLive()Returns
| Type | Description |
|---|---|
| Boolean | true if ready for recording; otherwise, false. |
Implements
IsPreviewPlaying()
Checks whether the take recorder is playing the selected take or not.
Declaration
public bool IsPreviewPlaying()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
Implements
IsRecording()
Checks whether the take recorder is recording or not.
Declaration
public bool IsRecording()Returns
| Type | Description |
|---|---|
| Boolean | true if playing; otherwise, false. |
Implements
PausePreview()
Pauses the playback of the selected take.
Declaration
public void PausePreview()Implements
PlayPreview()
Starts playing the selected take.
Declaration
public void PlayPreview()Implements
Rebuild()
Rebuilds the PlayableGraph and prepares the devices.
Declaration
public void Rebuild()SetLive(Boolean)
Use this method to set the take recorder ready for recording.
Declaration
public void SetLive(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | value | true to set ready; otherwise, false. |
Implements
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. |
Implements
StartRecording()
Starts the recording of a new take for the selected slate.
Declaration
public void StartRecording()Implements
StopRecording()
Stops the recording.
Declaration
public void StopRecording()