Class FaceDevice

A device used to control face animation capture and playback.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

LiveCaptureDevice

CompanionAppDevice<IFaceClient>

FaceDevice

Inherited Members

LiveCaptureDevice.IsRecording

LiveCaptureDevice.OnStopRecording()

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.ARKitFaceCapture

Assembly: Unity.LiveCapture.ARKitFaceCapture.dll

Syntax

[ExcludeFromPreset]
[CreateDeviceMenuItem("ARKit Face Device", 0)]
[AddComponentMenu("Live Capture/ARKit Face Capture/ARKit Face Device")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@4.0/manual/ref-component-arkit-face-device.html")]
public class FaceDevice : CompanionAppDevice<IFaceClient>

Remarks

The face capture data is in the format of Apple's ARKit face tracking.

Properties

Actor

Gets the FaceActor currently assigned to this device.

Declaration

public FaceActor Actor { get; set; }

Property Value

Type	Description
FaceActor	The assigned actor, or null if none is assigned.

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

SyncBuffer

The synchronized data buffer.

Declaration

public ITimedDataSource SyncBuffer { get; }

Property Value

Type	Description
ITimedDataSource

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

Methods

GetAssetName()

Gets the name used for the take asset name.

Declaration

protected override string GetAssetName()

Returns

Type	Description
string	The name of the asset.

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.GetAssetName()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

IsReady()

Indicates whether a device is ready for recording.

Declaration

public override bool IsReady()

Returns

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

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.IsReady()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

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

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnClientAssigned()

The device calls this method when a new client is assigned.

Declaration

protected override void OnClientAssigned()

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnClientAssigned()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnClientUnassigned()

The device calls this method when the client is unassigned.

Declaration

protected override void OnClientUnassigned()

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnClientUnassigned()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnDisable()

This function is called when the behaviour becomes disabled.

Declaration

protected override void OnDisable()

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnDisable()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnEnable()

This function is called when the object becomes enabled and active.

Declaration

protected override void OnEnable()

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnEnable()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnRegisterLiveProperties(IPropertyPreviewer)

The device calls this method when a live performance starts and properties are about to change.

Declaration

protected override void OnRegisterLiveProperties(IPropertyPreviewer previewer)

Parameters

Type	Name	Description
IPropertyPreviewer	previewer	The IPropertyPreviewer to use to register live properties.

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnRegisterLiveProperties(Unity.LiveCapture.IPropertyPreviewer)

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

OnStartRecording()

The device calls this method when the recording state has changed.

Declaration

protected override void OnStartRecording()

Overrides

Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnStartRecording()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

UpdateDevice()

Updates the internal state of the device.

Declaration

protected override void UpdateDevice()

Overrides

LiveCaptureDevice.UpdateDevice()

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

Write(ITakeBuilder)

Stores the recording into a take using a ITakeBuilder.

Declaration

public override void Write(ITakeBuilder takeBuilder)

Parameters

Type	Name	Description
ITakeBuilder	takeBuilder	The take builder object.

Overrides

LiveCaptureDevice.Write(ITakeBuilder)

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces

See Also

https://developer.apple.com/documentation/arkit/tracking_and_visualizing_faces