Class FaceDevice
A device used to control face animation capture and playback.
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@3.0/manual/ref-component-arkit-face-device.html")]
public class FaceDevice : CompanionAppDevice<IFaceClient>, ITimedDataSource, IRegistrable
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
BufferSize
Declaration
public int BufferSize { get; set; }
Property Value
See Also
FrameRate
Declaration
public FrameRate FrameRate { get; }
Property Value
See Also
Id
Declaration
public string Id { get; }
Property Value
See Also
IsSynchronized
Declaration
public bool IsSynchronized { get; set; }
Property Value
See Also
MaxBufferSize
Declaration
public int? MaxBufferSize { get; }
Property Value
See Also
MinBufferSize
Declaration
public int? MinBufferSize { get; }
Property Value
See Also
PresentationOffset
Declaration
public FrameTime PresentationOffset { get; set; }
Property Value
See Also
Synchronizer
Declaration
public ISynchronizer Synchronizer { get; set; }
Property Value
See Also
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.
|
See Also
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.
|
See Also
LiveUpdate()
Declaration
public override void LiveUpdate()
See Also
OnClientAssigned()
The device calls this method when a new client is assigned.
Declaration
protected override void OnClientAssigned()
See Also
OnClientUnassigned()
The device calls this method when the client is unassigned.
Declaration
protected override void OnClientUnassigned()
See Also
OnDisable()
This function is called when the behaviour becomes disabled.
Declaration
protected override void OnDisable()
See Also
OnEnable()
This function is called when the object becomes enabled and active.
Declaration
protected override void OnEnable()
See Also
OnRecordingChanged()
The device calls this method when the recording state has changed.
Declaration
protected override void OnRecordingChanged()
See Also
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
See Also
PresentAt(Timecode, FrameRate)
Declaration
public TimedSampleStatus PresentAt(Timecode timecode, FrameRate frameRate)
Parameters
Returns
See Also
TryGetBufferRange(out FrameTime, out FrameTime)
Declaration
public bool TryGetBufferRange(out FrameTime oldestSample, out FrameTime newestSample)
Parameters
Returns
See Also
UpdateDevice()
Declaration
public override void UpdateDevice()
See Also
Write(ITakeBuilder)
Declaration
public override void Write(ITakeBuilder takeBuilder)
Parameters
See Also
Implements
See Also