Class LiveCaptureDevice

The base class for implementing a capture device. It provides a mechanism to record live data from a source and preview it in the scene.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

LiveCaptureDevice

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]
[DisallowMultipleComponent]
public abstract class LiveCaptureDevice : MonoBehaviour

Methods

BuildLiveLink(PlayableGraph)

Builds the live link on this device using a given playable graph.

Declaration

[Obsolete("Use LiveUpdate instead")]
public abstract void BuildLiveLink(PlayableGraph graph)

Parameters

Type	Name	Description
PlayableGraph	graph	The PlayableGraph to drive the live link from.

GetTakeRecorder()

Gets the ITakeRecorder that operates this device.

Declaration

public ITakeRecorder GetTakeRecorder()

Returns

Type	Description
ITakeRecorder	The take recorder object reference.

IsLive()

Indicates whether a device is ready for recording.

Declaration

public abstract bool IsLive()

Returns

Type	Description
bool	true if ready for recording; otherwise, false.

IsRecording()

Checks if the device has started recording.

Declaration

public abstract bool IsRecording()

Returns

Type	Description
bool	true if the recording has started; otherwise, false.

LiveUpdate()

Override this method to update the device during live mode.

Declaration

public abstract void LiveUpdate()

Remarks

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

OnDestroy()

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

Declaration

protected virtual void OnDestroy()

Remarks

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

Refresh()

Updates the scene during edit mode.

Declaration

protected void Refresh()

Remarks

Call this method every time your device changes the scene. This method is only effective during edit mode.

SetLive(bool)

Use this method to set the device ready for recording.

Declaration

public abstract void SetLive(bool value)

Parameters

Type	Name	Description
bool	value	true to set ready; otherwise, false.

StartRecording()

Starts a new recording.

Declaration

public abstract void StartRecording()

StopRecording()

Stops the current recording.

Declaration

public abstract void StopRecording()

UpdateDevice()

Updates the internal state of the device.

Declaration

public abstract void UpdateDevice()

Write(ITakeBuilder)

Stores the recording into a take using a ITakeBuilder.

Declaration

public abstract void Write(ITakeBuilder takeBuilder)

Parameters

Type	Name	Description
ITakeBuilder	takeBuilder	The take builder object.