Class FaceDevice

A device used to control face animation capture and playback.

Inheritance

Object

LiveCaptureDevice

Unity.LiveCapture.CompanionApp.CompanionAppDevice<IFaceClient>

FaceDevice

Inherited Members

LiveCaptureDevice.GetTakeRecorder()

LiveCaptureDevice.OnDestroy()

LiveCaptureDevice.IsLive()

LiveCaptureDevice.SetLive(Boolean)

LiveCaptureDevice.IsRecording()

LiveCaptureDevice.StartRecording()

LiveCaptureDevice.StopRecording()

LiveCaptureDevice.Refresh()

Namespace: Unity.LiveCapture.ARKitFaceCapture

Syntax

public class FaceDevice : CompanionAppDevice<IFaceClient>, ICompanionAppDevice

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.

Methods

BuildLiveLink(PlayableGraph)

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

Declaration

public override void BuildLiveLink(PlayableGraph graph)

Parameters

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

Overrides

LiveCaptureDevice.BuildLiveLink(PlayableGraph)

GetAssetName()

Declaration

protected override string GetAssetName()

Returns

Type	Description
String

Overrides

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

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

LiveCaptureDevice.UpdateDevice()

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