XRFaceTracker — C# API

class XRFaceTrackerReckfellSharpInherits XRTracker

A tracked face.

An instance of this object represents a tracked face and its corresponding blend shapes. The blend shapes come from the Unified Expressions standard, and contain extended details and visuals for each blend shape. Additionally the Tracking Standard Comparison page documents the relationship between Unified Expressions and other standards. As face trackers are turned on they are registered with the XRServer.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

XRFaceTrackerConstructor

# XRFaceTracker

C#
public XRFaceTracker();

Properties1

BlendShapesProperty

# BlendShapes

C#
public float[] BlendShapes { get; set; }

The array of face blend shape weights with indices corresponding to the XRFaceTracker.BlendShapeEntry enum.

Methods5

GetBlendShapefloat

# GetBlendShape

C#
public float GetBlendShape(XRFaceTracker.BlendShapeEntry blendShape);

Returns the requested face blend shape weight.

Parameters
Name	Type	Default
`blendShape`	`XRFaceTracker.BlendShapeEntry`	—

Returns float

GetBlendShapesfloat[]

# GetBlendShapes

C#
public float[] GetBlendShapes();

Returns float[]

SetBlendShapevoid

# SetBlendShape

C#
public void SetBlendShape(XRFaceTracker.BlendShapeEntry blendShape, float weight);

Sets a face blend shape weight.

Parameters
Name	Type	Default
`blendShape`	`XRFaceTracker.BlendShapeEntry`	—
`weight`	`float`	—

SetBlendShapes2 overloads

# SetBlendShapes · 1/2

C#
public void SetBlendShapes(ReadOnlySpan<float> weights);

Parameters
Name	Type	Default
`weights`	`ReadOnlySpan<float>`	—

# SetBlendShapes · 2/2

C#
public void SetBlendShapes(float[] weights);

Parameters
Name	Type	Default
`weights`	`float[]`	—

XRFaceTracker.BlendShapeEntry

Value	Description
`BrowDown = 109`	Pulls both eyebrows down and in.
`BrowDownLeft = 108`	Pulls the left eyebrow down and in.
`BrowDownRight = 107`	Pulls the right eyebrow down and in.
`BrowInnerUpLeft = 23`	Inner left eyebrow pulls up.
`BrowInnerUpRight = 22`	Inner right eyebrow pulls up.
`BrowLowererLeft = 21`	Outer left eyebrow pulls down.
`BrowLowererRight = 20`	Outer right eyebrow pulls down.
`BrowOuterUpLeft = 25`	Outer left eyebrow pulls up.
`BrowOuterUpRight = 24`	Outer right eyebrow pulls up.
`BrowPinchLeft = 19`	Left eyebrow pinches in.
`BrowPinchRight = 18`	Right eyebrow pinches in.
`BrowUp = 112`	Both brows appear worried.
`BrowUpLeft = 111`	Left brow appears worried.
`BrowUpRight = 110`	Right brow appears worried.
`CheekPuff = 116`	Puffs both cheeks.
`CheekPuffLeft = 35`	Puffs the left side cheek.
`CheekPuffRight = 34`	Puffs the right side cheek.
`CheekSquint = 118`	Raises both cheeks.
`CheekSquintLeft = 33`	Raises the left side cheek.
`CheekSquintRight = 32`	Raises the right side cheek.
`CheekSuck = 117`	Sucks in both cheeks.
`CheekSuckLeft = 37`	Sucks in the left side cheek.
`CheekSuckRight = 36`	Sucks in the right side cheek.
`EyeClosed = 102`	Closes both eye lids.
`EyeClosedLeft = 9`	Closes the left eyelid.
`EyeClosedRight = 8`	Closes the right eyelid.
`EyeConstrict = 106`	Constricts both pupils.
`EyeConstrictLeft = 17`	Constricts the left eye pupil.
`EyeConstrictRight = 16`	Constricts the right eye pupil.
`EyeDilation = 105`	Dilates both pupils.
`EyeDilationLeft = 15`	Dilates the left eye pupil.
`EyeDilationRight = 14`	Dilates the right eye pupil.
`EyeLookDownLeft = 7`	Left eye looks downwards.
`EyeLookDownRight = 3`	Right eye looks downwards.
`EyeLookInLeft = 5`	Left eye looks inwards.
`EyeLookInRight = 1`	Right eye looks inwards.
`EyeLookOutLeft = 4`	Left eye looks outwards.
`EyeLookOutRight = 0`	Right eye looks outwards.
`EyeLookUpLeft = 6`	Left eye looks upwards.
`EyeLookUpRight = 2`	Right eye looks upwards.
`EyeSquint = 104`	Squints both eye lids.
`EyeSquintLeft = 11`	Squeezes the left eye socket muscles.
`EyeSquintRight = 10`	Squeezes the right eye socket muscles.
`EyeWide = 103`	Widens both eye lids.
`EyeWideLeft = 13`	Left eyelid widens beyond relaxed.
`EyeWideRight = 12`	Right eyelid widens beyond relaxed.
`JawBackward = 43`	Pushes jawbone backward.
`JawClench = 44`	Flexes jaw muscles.
`JawForward = 42`	Pushes jawbone forward.
`JawLeft = 41`	Pushes jawbone left.
`JawMandibleRaise = 45`	Raises the jawbone.
`JawOpen = 38`	Opens jawbone.
`JawRight = 40`	Pushes jawbone right.
`LipFunnel = 124`	Funnels in both lips.
`LipFunnelLower = 123`	Funnels in the lower lips.
`LipFunnelLowerLeft = 55`	Lower left lip part pushes into a funnel.
`LipFunnelLowerRight = 54`	Lower right lip part pushes into a funnel.
`LipFunnelUpper = 122`	Funnels in the upper lips.
`LipFunnelUpperLeft = 53`	Upper left lip part pushes into a funnel.
`LipFunnelUpperRight = 52`	Upper right lip part pushes into a funnel.
`LipPucker = 127`	Lips push outwards.
`LipPuckerLower = 126`	Lower lip part pushes outwards.
`LipPuckerLowerLeft = 59`	Lower left lip part pushes outwards.
`LipPuckerLowerRight = 58`	Lower right lip part pushes outwards.
`LipPuckerUpper = 125`	Upper lip part pushes outwards.
`LipPuckerUpperLeft = 57`	Upper left lip part pushes outwards.
`LipPuckerUpperRight = 56`	Upper right lip part pushes outwards.
`LipSuck = 121`	Tucks in both lips.
`LipSuckCornerLeft = 51`	Left lip corner folds into the mouth.
`LipSuckCornerRight = 50`	Right lip corner folds into the mouth.
`LipSuckLower = 120`	Tucks in the lower lips.
`LipSuckLowerLeft = 49`	Lower left lip part tucks in the mouth.
`LipSuckLowerRight = 48`	Lower right lip part tucks in the mouth.
`LipSuckUpper = 119`	Tucks in the upper lips.
`LipSuckUpperLeft = 47`	Upper left lip part tucks in the mouth.
`LipSuckUpperRight = 46`	Upper right lip part tucks in the mouth.
`Max = 143`	Represents the size of the `XRFaceTracker.BlendShapeEntry` enum.
`MouthClosed = 39`	Closes the mouth.
`MouthCornerPullLeft = 71`	Left lip corner pulls diagonally up and out.
`MouthCornerPullRight = 70`	Right lip corner pulls diagonally up and out.
`MouthCornerSlantLeft = 73`	Left corner lip slants up.
`MouthCornerSlantRight = 72`	Right corner lip slants up.
`MouthDimple = 140`	Lip corners dimple.
`MouthDimpleLeft = 79`	Left lip corner is pushed backwards.
`MouthDimpleRight = 78`	Right lip corner is pushed backwards.
`MouthFrownLeft = 75`	Left corner lip pulls down.
`MouthFrownRight = 74`	Right corner lip pulls down.
`MouthLeft = 132`	Moves mouth left.
`MouthLowerDown = 129`	Lowers the lower lips.
`MouthLowerDownLeft = 63`	Lower left part of the lip pulls up.
`MouthLowerDownRight = 62`	Lower right part of the lip pulls up.
`MouthLowerLeft = 69`	Moves lower lip left.
`MouthLowerRight = 68`	Moves lower lip right.
`MouthOpen = 130`	Mouth opens, revealing teeth.
`MouthPress = 142`	Mouth presses together.
`MouthPressLeft = 83`	Left side lips press and flatten together vertically.
`MouthPressRight = 82`	Right side lips press and flatten together vertically.
`MouthRaiserLower = 81`	Raises and slightly pushes out the lower mouth.
`MouthRaiserUpper = 80`	Raises and slightly pushes out the upper mouth.
`MouthRight = 131`	Moves mouth right.
`MouthSad = 138`	Mouth expresses sadness.
`MouthSadLeft = 137`	Left side of the mouth expresses sadness.
`MouthSadRight = 136`	Right side of the mouth expresses sadness.
`MouthSmile = 135`	Mouth expresses a smile.
`MouthSmileLeft = 134`	Left side of the mouth smiles.
`MouthSmileRight = 133`	Right side of the mouth smiles.
`MouthStretch = 139`	Mouth stretches.
`MouthStretchLeft = 77`	Mouth corner lip pulls out and down.
`MouthStretchRight = 76`	Mouth corner lip pulls out and down.
`MouthTightener = 141`	Mouth tightens.
`MouthTightenerLeft = 85`	Left side lips squeeze together horizontally.
`MouthTightenerRight = 84`	Right side lips squeeze together horizontally.
`MouthUpperDeepenLeft = 65`	Upper left lip part pushes in the cheek.
`MouthUpperDeepenRight = 64`	Upper right lip part pushes in the cheek.
`MouthUpperLeft = 67`	Moves upper lip left.
`MouthUpperRight = 66`	Moves upper lip right.
`MouthUpperUp = 128`	Raises the upper lips.
`MouthUpperUpLeft = 61`	Upper left part of the lip pulls up.
`MouthUpperUpRight = 60`	Upper right part of the lip pulls up.
`NasalConstrict = 115`	Both nose canals constrict.
`NasalConstrictLeft = 31`	Left side nose canal constricts.
`NasalConstrictRight = 30`	Right side nose canal constricts.
`NasalDilation = 114`	Both nose canals dilate.
`NasalDilationLeft = 29`	Left side nose canal dilates.
`NasalDilationRight = 28`	Right side nose canal dilates.
`NeckFlexLeft = 101`	Left side neck visibly flexes.
`NeckFlexRight = 100`	Right side neck visibly flexes.
`NoseSneer = 113`	Entire face sneers.
`NoseSneerLeft = 27`	Left side face sneers.
`NoseSneerRight = 26`	Right side face sneers.
`SoftPalateClose = 98`	Inner mouth throat closes.
`ThroatSwallow = 99`	The Adam's apple visibly swallows.
`TongueBlendDown = 92`	Tongue arches up then down inside the mouth.
`TongueCurlUp = 93`	Tongue arches down then up inside the mouth.
`TongueDown = 88`	Tongue points downwards.
`TongueFlat = 95`	Tongue flattens and thins out.
`TongueLeft = 90`	Tongue points left.
`TongueOut = 86`	Tongue visibly sticks out of the mouth.
`TongueRight = 89`	Tongue points right.
`TongueRoll = 91`	Sides of the tongue funnel, creating a roll.
`TongueSquish = 94`	Tongue squishes together and thickens.
`TongueTwistLeft = 97`	Tongue tip rotates counter-clockwise, with the rest following gradually.
`TongueTwistRight = 96`	Tongue tip rotates clockwise, with the rest following gradually.
`TongueUp = 87`	Tongue points upwards.