Class ARKitFaceSubsystem

The ARKit implementation of the XRFaceSubsystem. Do not create this directly. Use the SubsystemManager instead.

Inheritance

Object

XRSubsystem<XRFaceSubsystemDescriptor>

TrackingSubsystem<XRFace, XRFaceSubsystemDescriptor>

XRFaceSubsystem

ARKitFaceSubsystem

Inherited Members

XRFaceSubsystem.OnStart()

XRFaceSubsystem.OnDestroyed()

XRFaceSubsystem.OnStop()

XRFaceSubsystem.GetChanges(Allocator)

XRFaceSubsystem.GetFaceMesh(TrackableId, Allocator, XRFaceMesh)

XRFaceSubsystem.requestedMaximumFaceCount

XRFaceSubsystem.currentMaximumFaceCount

XRFaceSubsystem.supportedFaceCount

XRFaceSubsystem.provider

TrackingSubsystem<XRFace, XRFaceSubsystemDescriptor>.GetChanges(Allocator)

XRSubsystem<XRFaceSubsystemDescriptor>.OnDestroy()

XRSubsystem<XRFaceSubsystemDescriptor>.Start()

XRSubsystem<XRFaceSubsystemDescriptor>.Stop()

XRSubsystem<XRFaceSubsystemDescriptor>.running

Namespace: UnityEngine.XR.ARKit

Syntax

[Preserve]
public class ARKitFaceSubsystem : XRFaceSubsystem

Methods

CreateProvider()

Creates the ARKit-specific implementation which will service the XRFaceSubsystem.

Declaration

protected override XRFaceSubsystem.Provider CreateProvider()

Returns

Type	Description
XRFaceSubsystem.Provider	A new instance of the Provider specific to ARKit.

Overrides

XRFaceSubsystem.CreateProvider()

GetBlendShapeCoefficients(TrackableId, Allocator)

Get the blend shape coefficients for the face. Blend shapes describe a number of facial features on a scale of 0..1. For example, how closed is the left eye, how open is the mouth. See ARKitBlendShapeCoefficient for more details.

Declaration

public NativeArray<ARKitBlendShapeCoefficient> GetBlendShapeCoefficients(TrackableId faceId, Allocator allocator)

Parameters

Type	Name	Description
TrackableId	faceId	The TrackableId associated with the face to query.
Allocator	allocator	The allocator to use for the returned NativeArray.

Returns

Type	Description
NativeArray<ARKitBlendShapeCoefficient>	A new NativeArray allocated with allocator describing the blend shapes for the face with id faceId. The caller owns the NativeArray and is responsible for calling Dispose on it.