Class AndroidOpenXRFaceSubsystem

The Android-OpenXR implementation of the UnityEngine.XR.ARSubsystems.XRFaceSubsystem.

Inheritance

object

SubsystemWithProvider

SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>

TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>

XRFaceSubsystem

AndroidOpenXRFaceSubsystem

Implements

ISubsystem

Inherited Members

XRFaceSubsystem.requestedMaximumFaceCount

XRFaceSubsystem.currentMaximumFaceCount

XRFaceSubsystem.supportedFaceCount

XRFaceSubsystem.GetChanges(Allocator)

XRFaceSubsystem.GetFaceMesh(TrackableId, Allocator, ref XRFaceMesh)

XRFaceSubsystem.TryGetBlendShapes(TrackableId, Allocator)

TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.GetChanges(Allocator)

SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.subsystemDescriptor

SubsystemWithProvider.Start()

SubsystemWithProvider.Stop()

SubsystemWithProvider.Destroy()

SubsystemWithProvider.running

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.OpenXR.Features.Android

Assembly: Unity.XR.AndroidOpenXR.dll

Syntax

[Preserve]
public sealed class AndroidOpenXRFaceSubsystem : XRFaceSubsystem, ISubsystem

Constructors

AndroidOpenXRFaceSubsystem()

Do not call this directly. Call Create on a relevant UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor instead.

Declaration

public AndroidOpenXRFaceSubsystem()

Properties

inwardID

UnityEngine.XR.ARSubsystems.TrackableId for the face of the person wearing the headset.

Declaration

public TrackableId inwardID { get; }

Property Value

Type	Description
TrackableId

Methods

TryGetInwardBlendShapes(Allocator)

Attempts to get the blend shapes for the face of the person wearing the headset. This call may fail if no blend shape data can be found for the inward face.

Declaration

public Result<NativeArray<XRFaceBlendShape>> TryGetInwardBlendShapes(Allocator allocator)

Parameters

Type	Name	Description
Allocator	allocator	The allocator to use for the returned blend shapes native array.

Returns

Type	Description
Result<NativeArray<XRFaceBlendShape>>	A result of a new native array, allocated with the requested allocation strategy, describing the blend shapes for the inward face. You own the returned native array and are responsible for calling Dispose on it if you have opted for the Allocator.Persistent strategy.

TryGetInwardRegionConfidences(Allocator)

Attempts to get the region confidences associated with the facial blend shapes of the person wearing the headset. This call might fail if no confidence region data can be found for the inward face.

Declaration

public Result<NativeArray<float>> TryGetInwardRegionConfidences(Allocator allocator)

Parameters

Type	Name	Description
Allocator	allocator	The allocator to use for the returned region confidence native array.

Returns

Type	Description
Result<NativeArray<float>>	A result of a new native array, allocated with the requested allocation strategy, containing confidence values corresponding to a AndroidXRFaceConfidenceRegion based on the index of the array. You own the returned native array and are responsible for calling Dispose on it if you have opted for the Allocator.Persistent strategy.

TryGetIsFaceTrackingCalibrated()

Attempts to get whether or not face tracking is calibrated for the person wearing the headset. This call may fail if the underlying runtime does not support querying the calibration state. If face tracking is not calibrated, consider directing users to the face calibration flow in the operating system settings.

Declaration

public Result<bool> TryGetIsFaceTrackingCalibrated()

Returns

Type	Description
Result<bool>	A result indicating whether or not tracking is calibrated for the inward face. This indicator is only valid if the result is successful and otherwise may be uninitialized or default.

Implements

ISubsystem