Class TakeRecorder

A take recorder that manages a set of capture devices.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
TakeRecorder
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindFirstObjectByType(System.Type)
UnityEngine.Object.FindAnyObjectByType(System.Type)
UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)
Namespace: Unity.LiveCapture
Syntax
[ExecuteAlways]
[DefaultExecutionOrder(-10)]
[DisallowMultipleComponent]
[ExcludeFromPreset]
[RequireComponent(typeof(PlayableDirector))]
[AddComponentMenu("Live Capture/Take Recorder")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@4.0/manual/ref-component-take-recorder.html")]
public class TakeRecorder : MonoBehaviour, ITakeRecorderInternal, ITakeRecorder

Properties

FrameRate

The frame rate to use for recording.

Declaration
public FrameRate FrameRate { get; set; }
Property Value
Type Description
FrameRate
Implements

Shot

The current IShot to record to.

Declaration
public IShot Shot { get; }
Property Value
Type Description
IShot
Implements

Methods

GetPreviewDuration()

Returns the current playback duration of the selected take.

Declaration
public double GetPreviewDuration()
Returns
Type Description
Double

The current duration in seconds.
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

GetRecordingElapsedTime()

Returns the time elapsed since the start of the recording.

Declaration
public double GetRecordingElapsedTime()
Returns
Type Description
Double

The time elapsed since the start of the recording, 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

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

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>