Class TakeRecorder

A take recorder that manages a set of capture devices.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
TakeRecorder
Implements
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
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@3.0/manual/ref-component-take-recorder.html")]
public class TakeRecorder : MonoBehaviour, ITakeRecorder

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.

GetPreviewDuration()

Returns the current playback duration of the selected take.

Declaration
public double GetPreviewDuration()
Returns
Type Description
double

The current duration in seconds.

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()

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()

Events

PlaybackStateChanged

TakeRecorder executes this event when playback has started or stopped.

Declaration
public static event Action<TakeRecorder> PlaybackStateChanged
Event Type
Type Description
Action<TakeRecorder>

RecordingStateChanged

TakeRecorder executes this event when recording has started or stopped.

Declaration
public static event Action<TakeRecorder> RecordingStateChanged
Event Type
Type Description
Action<TakeRecorder>

Implements