Class FaceDevice
A device used to control face animation capture and playback.
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: Unity.LiveCapture.ARKitFaceCapture
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@1.1/manual/ref-component-arkit-face-device.html")]
public class FaceDevice : CompanionAppDevice<IFaceClient>, ICompanionAppDeviceRemarks
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. |
Methods
BuildLiveLink(PlayableGraph)
Builds the live link on this device using a given playable graph.
Declaration
[Obsolete("Use LiveUpdate instead")]
public override void BuildLiveLink(PlayableGraph graph)Parameters
| Type | Name | Description |
|---|---|---|
| PlayableGraph | graph | The PlayableGraph to drive the live link from. |
Overrides
GetAssetName()
Declaration
protected override string GetAssetName()Returns
| Type | Description |
|---|---|
| String |
Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.GetAssetName()
LiveUpdate()
Override this method to update the device during live mode.
Declaration
public override void LiveUpdate()Overrides
Remarks
This method is called after the animation system execution and before the script's LateUpdate.
OnClientAssigned()
Declaration
protected override void OnClientAssigned()Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnClientAssigned()
OnClientUnassigned()
Declaration
protected override void OnClientUnassigned()Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnClientUnassigned()
OnDisable()
Declaration
protected override void OnDisable()Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnDisable()
OnEnable()
Declaration
protected override void OnEnable()Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnEnable()
OnRecordingChanged()
Declaration
protected override void OnRecordingChanged()Overrides
Unity.LiveCapture.CompanionApp.CompanionAppDevice<Unity.LiveCapture.ARKitFaceCapture.IFaceClient>.OnRecordingChanged()
UpdateDevice()
Updates the internal state of the device.
Declaration
public override void UpdateDevice()Overrides
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. |