Scripting API
FaceTrackingModule
Mouth

Mouth

Exposes details and key points of the mouth of a detected Face object.
Key points are returned in the detected face's local coordinate system. Use Face.cameraTransform.applyToPoint() to convert the point to the camera's coordinate system.

Example

Properties

PropertyDescription

center

(get) center: PointSignal
(set) (Not Available)


The location of the center of the mouth, as a PointSignal.

leftCorner

(get) leftCorner: PointSignal
(set) (Not Available)


The location of the left corner of the mouth, as a PointSignal.

lowerLipCenter

(get) lowerLipCenter: PointSignal
(set) (Not Available)


The location of the center of the lower lip, as a PointSignal.

lowerLipCurvature

(get) lowerLipCurvature: ScalarSignal
(set) (Not Available)


The curvature of the lower lip relative to the lip center, as a ScalarSignal.
A value of 0 represents no curvature on the lower lip. A mouth angled higher than the lip center results in a positive curvature value, while a mouth angled lower than the lip center results in a negative curvature value.

openness

(get) openness: ScalarSignal
(set) (Not Available)


The openness of the mouth, as a ScalarSignal.
The higher the value returned, the more wide open the detected mouth is. The minimum value is 0, which indicates a closed mouth.

rightCorner

(get) rightCorner: PointSignal
(set) (Not Available)


The location of the right corner of the mouth, as a PointSignal.

upperLipCenter

(get) upperLipCenter: PointSignal
(set) (Not Available)


The location of the center of the upper lip, as a PointSignal.

upperLipCurvature

(get) upperLipCurvature: ScalarSignal
(set) (Not Available)


The curvature of the upper lip relative to the lip center, as a ScalarSignal.
A value of 0 represents no curvature on the upper lip. A mouth angled higher than the lip center results in a positive curvature value, while a mouth angled lower than the lip center results in a negative curvature value.

Methods

This module exposes no methods.