docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class LiveStreamCaptureDevice

    The base class for implementing a capture device that manages a LiveStream.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    LiveCaptureDevice
    LiveStreamCaptureDevice
    CameraTrackingDevice
    Inherited Members
    LiveCaptureDevice.IsRecording
    LiveCaptureDevice.UpdateDevice()
    LiveCaptureDevice.IsReady()
    LiveCaptureDevice.OnStopRecording()
    LiveCaptureDevice.Write(ITakeBuilder)
    LiveCaptureDevice.Refresh()
    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.destroyCancellationToken
    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
    public abstract class LiveStreamCaptureDevice : LiveCaptureDevice

    Properties

    CurrentFrameTime

    The current frame time and frame rate of the LiveStream.

    Declaration
    public FrameTimeWithRate? CurrentFrameTime { get; }
    Property Value
    Type Description
    FrameTimeWithRate?
    See Also
    LiveStream

    FirstFrameTime

    The time of the first recorded frame.

    Declaration
    protected double? FirstFrameTime { get; }
    Property Value
    Type Description
    double?
    See Also
    LiveStream

    Methods

    BakeAnimationClip()

    Generates an animation clip from the last recording.

    Declaration
    protected AnimationClip BakeAnimationClip()
    Returns
    Type Description
    AnimationClip

    An animation clip containing the last recording.

    See Also
    LiveStream

    CreateLiveProperties(LiveStream)

    Override this method to create new properties to the specified LiveStream.

    Declaration
    protected virtual void CreateLiveProperties(LiveStream stream)
    Parameters
    Type Name Description
    LiveStream stream

    The LiveStream to modify.

    See Also
    LiveStream

    LiveUpdate()

    Override this method to update the device during live mode.

    Declaration
    protected override void LiveUpdate()
    Overrides
    LiveCaptureDevice.LiveUpdate()
    Remarks

    This method is called after the animation system execution and before the script's LateUpdate.

    See Also
    LiveStream

    OnDisable()

    The device calls this method when the device is about to get disabled.

    Declaration
    protected override void OnDisable()
    Overrides
    LiveCaptureDevice.OnDisable()
    Remarks

    If you override this method, call the base method in your implementation.

    See Also
    LiveStream

    OnEnable()

    The device calls this method when the device is about to get enabled.

    Declaration
    protected override void OnEnable()
    Overrides
    LiveCaptureDevice.OnEnable()
    Remarks

    If you override this method, call the base method in your implementation.

    See Also
    LiveStream

    OnStartRecording()

    The device calls this method when a new recording started.

    Declaration
    protected override void OnStartRecording()
    Overrides
    LiveCaptureDevice.OnStartRecording()
    See Also
    LiveStream

    ProcessFrame(LiveStream)

    Override this method to process the specified LiveStream.

    Declaration
    protected abstract void ProcessFrame(LiveStream stream)
    Parameters
    Type Name Description
    LiveStream stream

    The LiveStream to modify.

    See Also
    LiveStream

    RegisterLiveProperties()

    Registers the values of the live properties to prevent Unity from marking Prefabs or the Scene as modified when you preview animations.

    Declaration
    protected void RegisterLiveProperties()
    See Also
    LiveStream

    RestoreLiveProperties()

    Restores the original values of any created live property.

    Declaration
    protected void RestoreLiveProperties()
    See Also
    LiveStream

    UpdateStream(Transform, FrameTimeWithRate)

    Updates the internal LiveStream.

    Declaration
    protected void UpdateStream(Transform root, FrameTimeWithRate frameTime)
    Parameters
    Type Name Description
    Transform root

    The root transform to bind.

    FrameTimeWithRate frameTime

    The frame time to use for recording.

    See Also
    LiveStream

    See Also

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