API reference
API reference
Select your platform
No SDKs available
No versions available

OVRFaceExpressions Class

This class manages the face expressions data.
OVRFaceExpressions extends MonoBehaviour.
OVRFaceExpressions extends IReadOnlyCollection< float >.
OVRFaceExpressions extends OVRFaceExpressions.WeightProvider.

Overview

Public Types

enum
FaceRegionConfidence {
FaceRegionConfidence.Lower = OVRPlugin.FaceRegionConfidence.Lower, FaceRegionConfidence.Upper = OVRPlugin.FaceRegionConfidence.Upper, FaceRegionConfidence.Max = OVRPlugin.FaceRegionConfidence.Max
}
List of face parts used for getting the face tracking confidence weight in TryGetWeightConfidence.
enum
FaceTrackingDataSource {
FaceTrackingDataSource.Visual = OVRPlugin.FaceTrackingDataSource.Visual, FaceTrackingDataSource.Audio = OVRPlugin.FaceTrackingDataSource.Audio, FaceTrackingDataSource.Count = OVRPlugin.FaceTrackingDataSource.Count
}
enum
FaceExpression {
FaceExpression.Invalid = OVRPlugin.FaceExpression2.Invalid, FaceExpression.BrowLowererL = OVRPlugin.FaceExpression2.Brow_Lowerer_L, FaceExpression.BrowLowererR = OVRPlugin.FaceExpression2.Brow_Lowerer_R, FaceExpression.CheekPuffL = OVRPlugin.FaceExpression2.Cheek_Puff_L, FaceExpression.CheekPuffR = OVRPlugin.FaceExpression2.Cheek_Puff_R, FaceExpression.CheekRaiserL = OVRPlugin.FaceExpression2.Cheek_Raiser_L, FaceExpression.CheekRaiserR = OVRPlugin.FaceExpression2.Cheek_Raiser_R, FaceExpression.CheekSuckL = OVRPlugin.FaceExpression2.Cheek_Suck_L, FaceExpression.CheekSuckR = OVRPlugin.FaceExpression2.Cheek_Suck_R, FaceExpression.ChinRaiserB = OVRPlugin.FaceExpression2.Chin_Raiser_B, FaceExpression.ChinRaiserT = OVRPlugin.FaceExpression2.Chin_Raiser_T, FaceExpression.DimplerL = OVRPlugin.FaceExpression2.Dimpler_L, FaceExpression.DimplerR = OVRPlugin.FaceExpression2.Dimpler_R, FaceExpression.EyesClosedL = OVRPlugin.FaceExpression2.Eyes_Closed_L, FaceExpression.EyesClosedR = OVRPlugin.FaceExpression2.Eyes_Closed_R, FaceExpression.EyesLookDownL = OVRPlugin.FaceExpression2.Eyes_Look_Down_L, FaceExpression.EyesLookDownR = OVRPlugin.FaceExpression2.Eyes_Look_Down_R, FaceExpression.EyesLookLeftL = OVRPlugin.FaceExpression2.Eyes_Look_Left_L, FaceExpression.EyesLookLeftR = OVRPlugin.FaceExpression2.Eyes_Look_Left_R, FaceExpression.EyesLookRightL = OVRPlugin.FaceExpression2.Eyes_Look_Right_L, FaceExpression.EyesLookRightR = OVRPlugin.FaceExpression2.Eyes_Look_Right_R, FaceExpression.EyesLookUpL = OVRPlugin.FaceExpression2.Eyes_Look_Up_L, FaceExpression.EyesLookUpR = OVRPlugin.FaceExpression2.Eyes_Look_Up_R, FaceExpression.InnerBrowRaiserL = OVRPlugin.FaceExpression2.Inner_Brow_Raiser_L, FaceExpression.InnerBrowRaiserR = OVRPlugin.FaceExpression2.Inner_Brow_Raiser_R, FaceExpression.JawDrop = OVRPlugin.FaceExpression2.Jaw_Drop, FaceExpression.JawSidewaysLeft = OVRPlugin.FaceExpression2.Jaw_Sideways_Left, FaceExpression.JawSidewaysRight = OVRPlugin.FaceExpression2.Jaw_Sideways_Right, FaceExpression.JawThrust = OVRPlugin.FaceExpression2.Jaw_Thrust, FaceExpression.LidTightenerL = OVRPlugin.FaceExpression2.Lid_Tightener_L, FaceExpression.LidTightenerR = OVRPlugin.FaceExpression2.Lid_Tightener_R, FaceExpression.LipCornerDepressorL = OVRPlugin.FaceExpression2.Lip_Corner_Depressor_L, FaceExpression.LipCornerDepressorR = OVRPlugin.FaceExpression2.Lip_Corner_Depressor_R, FaceExpression.LipCornerPullerL = OVRPlugin.FaceExpression2.Lip_Corner_Puller_L, FaceExpression.LipCornerPullerR = OVRPlugin.FaceExpression2.Lip_Corner_Puller_R, FaceExpression.LipFunnelerLB = OVRPlugin.FaceExpression2.Lip_Funneler_LB, FaceExpression.LipFunnelerLT = OVRPlugin.FaceExpression2.Lip_Funneler_LT, FaceExpression.LipFunnelerRB = OVRPlugin.FaceExpression2.Lip_Funneler_RB, FaceExpression.LipFunnelerRT = OVRPlugin.FaceExpression2.Lip_Funneler_RT, FaceExpression.LipPressorL = OVRPlugin.FaceExpression2.Lip_Pressor_L, FaceExpression.LipPressorR = OVRPlugin.FaceExpression2.Lip_Pressor_R, FaceExpression.LipPuckerL = OVRPlugin.FaceExpression2.Lip_Pucker_L, FaceExpression.LipPuckerR = OVRPlugin.FaceExpression2.Lip_Pucker_R, FaceExpression.LipStretcherL = OVRPlugin.FaceExpression2.Lip_Stretcher_L, FaceExpression.LipStretcherR = OVRPlugin.FaceExpression2.Lip_Stretcher_R, FaceExpression.LipSuckLB = OVRPlugin.FaceExpression2.Lip_Suck_LB, FaceExpression.LipSuckLT = OVRPlugin.FaceExpression2.Lip_Suck_LT, FaceExpression.LipSuckRB = OVRPlugin.FaceExpression2.Lip_Suck_RB, FaceExpression.LipSuckRT = OVRPlugin.FaceExpression2.Lip_Suck_RT, FaceExpression.LipTightenerL = OVRPlugin.FaceExpression2.Lip_Tightener_L, FaceExpression.LipTightenerR = OVRPlugin.FaceExpression2.Lip_Tightener_R, FaceExpression.LipsToward = OVRPlugin.FaceExpression2.Lips_Toward, FaceExpression.LowerLipDepressorL = OVRPlugin.FaceExpression2.Lower_Lip_Depressor_L, FaceExpression.LowerLipDepressorR = OVRPlugin.FaceExpression2.Lower_Lip_Depressor_R, FaceExpression.MouthLeft = OVRPlugin.FaceExpression2.Mouth_Left, FaceExpression.MouthRight = OVRPlugin.FaceExpression2.Mouth_Right, FaceExpression.NoseWrinklerL = OVRPlugin.FaceExpression2.Nose_Wrinkler_L, FaceExpression.NoseWrinklerR = OVRPlugin.FaceExpression2.Nose_Wrinkler_R, FaceExpression.OuterBrowRaiserL = OVRPlugin.FaceExpression2.Outer_Brow_Raiser_L, FaceExpression.OuterBrowRaiserR = OVRPlugin.FaceExpression2.Outer_Brow_Raiser_R, FaceExpression.UpperLidRaiserL = OVRPlugin.FaceExpression2.Upper_Lid_Raiser_L, FaceExpression.UpperLidRaiserR = OVRPlugin.FaceExpression2.Upper_Lid_Raiser_R, FaceExpression.UpperLipRaiserL = OVRPlugin.FaceExpression2.Upper_Lip_Raiser_L, FaceExpression.UpperLipRaiserR = OVRPlugin.FaceExpression2.Upper_Lip_Raiser_R, FaceExpression.TongueTipInterdental = OVRPlugin.FaceExpression2.Tongue_Tip_Interdental, FaceExpression.TongueTipAlveolar = OVRPlugin.FaceExpression2.Tongue_Tip_Alveolar, FaceExpression.TongueFrontDorsalPalate = OVRPlugin.FaceExpression2.Tongue_Front_Dorsal_Palate, FaceExpression.TongueMidDorsalPalate = OVRPlugin.FaceExpression2.Tongue_Mid_Dorsal_Palate, FaceExpression.TongueBackDorsalVelar = OVRPlugin.FaceExpression2.Tongue_Back_Dorsal_Velar, FaceExpression.TongueOut = OVRPlugin.FaceExpression2.Tongue_Out, FaceExpression.TongueRetreat = OVRPlugin.FaceExpression2.Tongue_Retreat, FaceExpression.Max = OVRPlugin.FaceExpression2.Max
}
List of face expressions.

Properties

bool
True if face tracking is enabled, otherwise false.
bool
True if the facial expressions are valid, otherwise false.
bool
True if the eye look-related blend shapes are valid, otherwise false.
float
This will return the weight of the given expression.
int
Count[Get]

Public Member Functions

float
GetWeight
( FaceExpression expression )
bool
TryGetFaceExpressionWeight
( FaceExpression expression,
out float weight )
This method tries to gets the weight of the given expression if it's available.
bool
TryGetWeightConfidence
out float weightConfidence )
This method tries to gets the confidence weight of the given face part if it's available.
bool
TryGetFaceTrackingDataSource
( out FaceTrackingDataSource dataSource )
void
CopyTo
( float[] array,
int startIndex )
Copies expression weights to a pre-allocated array.
float[]
ToArray ( )
Allocates a float array and copies expression weights to it.
FaceExpressionsEnumerator

Details

Detailed Description

Refers to the OVRFaceExpressions.FaceExpression enum for the list of face expressions.

Member Enumerations

enum OVRFaceExpressions.FaceRegionConfidence
List of face parts used for getting the face tracking confidence weight in TryGetWeightConfidence.
Enumerator
Lower
Represents the lower part of the face.
Upper
Represents the upper part of the face.
Max
Used to determine the size of the FaceRegionConfidence enum.
enum OVRFaceExpressions.FaceTrackingDataSource
Enumerator
Visual
= OVRPlugin.FaceTrackingDataSource.Visual
Audio
= OVRPlugin.FaceTrackingDataSource.Audio
Count
= OVRPlugin.FaceTrackingDataSource.Count
enum OVRFaceExpressions.FaceExpression
List of face expressions.
Enumerator
Invalid
= OVRPlugin.FaceExpression2.Invalid
BrowLowererL
= OVRPlugin.FaceExpression2.Brow_Lowerer_L
BrowLowererR
= OVRPlugin.FaceExpression2.Brow_Lowerer_R
CheekPuffL
= OVRPlugin.FaceExpression2.Cheek_Puff_L
CheekPuffR
= OVRPlugin.FaceExpression2.Cheek_Puff_R
CheekRaiserL
= OVRPlugin.FaceExpression2.Cheek_Raiser_L
CheekRaiserR
= OVRPlugin.FaceExpression2.Cheek_Raiser_R
CheekSuckL
= OVRPlugin.FaceExpression2.Cheek_Suck_L
CheekSuckR
= OVRPlugin.FaceExpression2.Cheek_Suck_R
ChinRaiserB
= OVRPlugin.FaceExpression2.Chin_Raiser_B
ChinRaiserT
= OVRPlugin.FaceExpression2.Chin_Raiser_T
DimplerL
= OVRPlugin.FaceExpression2.Dimpler_L
DimplerR
= OVRPlugin.FaceExpression2.Dimpler_R
EyesClosedL
= OVRPlugin.FaceExpression2.Eyes_Closed_L
EyesClosedR
= OVRPlugin.FaceExpression2.Eyes_Closed_R
EyesLookDownL
= OVRPlugin.FaceExpression2.Eyes_Look_Down_L
EyesLookDownR
= OVRPlugin.FaceExpression2.Eyes_Look_Down_R
EyesLookLeftL
= OVRPlugin.FaceExpression2.Eyes_Look_Left_L
EyesLookLeftR
= OVRPlugin.FaceExpression2.Eyes_Look_Left_R
EyesLookRightL
= OVRPlugin.FaceExpression2.Eyes_Look_Right_L
EyesLookRightR
= OVRPlugin.FaceExpression2.Eyes_Look_Right_R
EyesLookUpL
= OVRPlugin.FaceExpression2.Eyes_Look_Up_L
EyesLookUpR
= OVRPlugin.FaceExpression2.Eyes_Look_Up_R
InnerBrowRaiserL
= OVRPlugin.FaceExpression2.Inner_Brow_Raiser_L
InnerBrowRaiserR
= OVRPlugin.FaceExpression2.Inner_Brow_Raiser_R
JawDrop
= OVRPlugin.FaceExpression2.Jaw_Drop
JawSidewaysLeft
= OVRPlugin.FaceExpression2.Jaw_Sideways_Left
JawSidewaysRight
= OVRPlugin.FaceExpression2.Jaw_Sideways_Right
JawThrust
= OVRPlugin.FaceExpression2.Jaw_Thrust
LidTightenerL
= OVRPlugin.FaceExpression2.Lid_Tightener_L
LidTightenerR
= OVRPlugin.FaceExpression2.Lid_Tightener_R
LipCornerDepressorL
= OVRPlugin.FaceExpression2.Lip_Corner_Depressor_L
LipCornerDepressorR
= OVRPlugin.FaceExpression2.Lip_Corner_Depressor_R
LipCornerPullerL
= OVRPlugin.FaceExpression2.Lip_Corner_Puller_L
LipCornerPullerR
= OVRPlugin.FaceExpression2.Lip_Corner_Puller_R
LipFunnelerLB
= OVRPlugin.FaceExpression2.Lip_Funneler_LB
LipFunnelerLT
= OVRPlugin.FaceExpression2.Lip_Funneler_LT
LipFunnelerRB
= OVRPlugin.FaceExpression2.Lip_Funneler_RB
LipFunnelerRT
= OVRPlugin.FaceExpression2.Lip_Funneler_RT
LipPressorL
= OVRPlugin.FaceExpression2.Lip_Pressor_L
LipPressorR
= OVRPlugin.FaceExpression2.Lip_Pressor_R
LipPuckerL
= OVRPlugin.FaceExpression2.Lip_Pucker_L
LipPuckerR
= OVRPlugin.FaceExpression2.Lip_Pucker_R
LipStretcherL
= OVRPlugin.FaceExpression2.Lip_Stretcher_L
LipStretcherR
= OVRPlugin.FaceExpression2.Lip_Stretcher_R
LipSuckLB
= OVRPlugin.FaceExpression2.Lip_Suck_LB
LipSuckLT
= OVRPlugin.FaceExpression2.Lip_Suck_LT
LipSuckRB
= OVRPlugin.FaceExpression2.Lip_Suck_RB
LipSuckRT
= OVRPlugin.FaceExpression2.Lip_Suck_RT
LipTightenerL
= OVRPlugin.FaceExpression2.Lip_Tightener_L
LipTightenerR
= OVRPlugin.FaceExpression2.Lip_Tightener_R
LipsToward
= OVRPlugin.FaceExpression2.Lips_Toward
LowerLipDepressorL
= OVRPlugin.FaceExpression2.Lower_Lip_Depressor_L
LowerLipDepressorR
= OVRPlugin.FaceExpression2.Lower_Lip_Depressor_R
MouthLeft
= OVRPlugin.FaceExpression2.Mouth_Left
MouthRight
= OVRPlugin.FaceExpression2.Mouth_Right
NoseWrinklerL
= OVRPlugin.FaceExpression2.Nose_Wrinkler_L
NoseWrinklerR
= OVRPlugin.FaceExpression2.Nose_Wrinkler_R
OuterBrowRaiserL
= OVRPlugin.FaceExpression2.Outer_Brow_Raiser_L
OuterBrowRaiserR
= OVRPlugin.FaceExpression2.Outer_Brow_Raiser_R
UpperLidRaiserL
= OVRPlugin.FaceExpression2.Upper_Lid_Raiser_L
UpperLidRaiserR
= OVRPlugin.FaceExpression2.Upper_Lid_Raiser_R
UpperLipRaiserL
= OVRPlugin.FaceExpression2.Upper_Lip_Raiser_L
UpperLipRaiserR
= OVRPlugin.FaceExpression2.Upper_Lip_Raiser_R
TongueTipInterdental
= OVRPlugin.FaceExpression2.Tongue_Tip_Interdental
TongueTipAlveolar
= OVRPlugin.FaceExpression2.Tongue_Tip_Alveolar
TongueFrontDorsalPalate
= OVRPlugin.FaceExpression2.Tongue_Front_Dorsal_Palate
TongueMidDorsalPalate
= OVRPlugin.FaceExpression2.Tongue_Mid_Dorsal_Palate
TongueBackDorsalVelar
= OVRPlugin.FaceExpression2.Tongue_Back_Dorsal_Velar
TongueOut
= OVRPlugin.FaceExpression2.Tongue_Out
TongueRetreat
= OVRPlugin.FaceExpression2.Tongue_Retreat
Max
= OVRPlugin.FaceExpression2.Max

Properties

bool OVRFaceExpressions.FaceTrackingEnabled
True if face tracking is enabled, otherwise false.
bool OVRFaceExpressions.ValidExpressions
True if the facial expressions are valid, otherwise false.
This value gets updated in every frame. You should check this value before querying for face expressions.
bool OVRFaceExpressions.EyeFollowingBlendshapesValid
True if the eye look-related blend shapes are valid, otherwise false.
This property affects the behavior of two sets of blend shapes.
EyesLook:
  • FaceExpression.EyesLookDownL
  • FaceExpression.EyesLookDownR
  • FaceExpression.EyesLookLeftL
  • FaceExpression.EyesLookLeftR
  • FaceExpression.EyesLookRightL
  • FaceExpression.EyesLookRightR
  • FaceExpression.EyesLookUpL
  • FaceExpression.EyesLookUpR
EyesClosed:
  • FaceExpression.EyesClosedL
  • FaceExpression.EyesClosedR
When EyeFollowingBlendshapesValid is false:
  • The EyesLook blend shapes are set to zero.
  • The EyesClosed blend shapes range from 0..1, and represent the true state of the eyelids.
When EyeFollowingBlendshapesValid is true:
  • The EyesLook blend shapes are valid.
  • The EyesClosed blend shapes are modified so that the sum of the EyesClosedX and EyesLookDownX blend shapes range from 0..1. This helps avoid double deformation of the avatar's eye lids when they may be driven by both the EyesClosed and EyesLookDown blend shapes. To recover the true EyesClosed values, add the minimum of EyesLookDownL and EyesLookDownR blend shapes back using the following formula: EyesClosedL += min(EyesLookDownL, EyesLookDownR) EyesClosedR += min(EyesLookDownL, EyesLookDownR)
float OVRFaceExpressions.this[FaceExpression expression]
This will return the weight of the given expression.
Returns
Returns weight of expression ranged between 0.0 to 100.0.
Exceptions
InvalidOperationExceptionArgumentOutOfRangeException
Thrown when expression value is not in range.
int OVRFaceExpressions.Count
No description available.

Member Functions

float OVRFaceExpressions.GetWeight
( FaceExpression expression )
No description available.
bool OVRFaceExpressions.TryGetFaceExpressionWeight
( FaceExpression expression,
out float weight )
This method tries to gets the weight of the given expression if it's available.
Parameters
expression
The expression to get the weight of.
weight
The output argument that will contain the expression weight or 0.0 if it's not available.
Returns
Returns true if the expression weight is available, false otherwise
bool OVRFaceExpressions.TryGetWeightConfidence
out float weightConfidence )
This method tries to gets the confidence weight of the given face part if it's available.
Parameters
region
The part of the face to get the confidence weight of.
weightConfidence
The output argument that will contain the weight confidence or 0.0 if it's not available.
Returns
Returns true if the weight confidence is available, false otherwise
bool OVRFaceExpressions.TryGetFaceTrackingDataSource
( out FaceTrackingDataSource dataSource )
No description available.
void OVRFaceExpressions.CopyTo
( float[] array,
int startIndex )
Copies expression weights to a pre-allocated array.
Parameters
array
Pre-allocated destination array for expression weights
startIndex
Starting index in the destination array
Exceptions
ArgumentNullException
Thrown when array is null.
ArgumentException
Thrown when there is not enough capacity to copy weights to array at startIndex index.
ArgumentOutOfRangeException
Thrown when startIndex value is out of array bounds.
InvalidOperationException
float[] OVRFaceExpressions.ToArray ( )
Allocates a float array and copies expression weights to it.
FaceExpressionsEnumerator OVRFaceExpressions.GetEnumerator ( )
No description available.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta