docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class TakeRecorder

    A take recorder that manages a set of capture devices.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    TakeRecorder
    Implements
    ITakeRecorder
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    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.1/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()

    Implements

    ITakeRecorder
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)