Face
Face tracking, face effects, and face expression events.
Commonly used
HeadUsed to move and rotate SceneObjects in sync with the user's head movements.FaceMaskVisualMaps a 2D texture to the user's face.FaceFoundEventTriggered when a new face is detected and starts being tracked.EyeColorVisualApplies an eye color effect to a face.FaceStretchVisualUsed to apply deformation effects to specific regions of a tracked face.RetouchVisualAdds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc.
Guides
Face ExpressionsThe Face Expression effect gives you information about the current expression of the user's face, such as whether the user is blinking their left eye or opening their mouth.Face ExpressionsThis guide shows how you can use face expressions of the user to drive a 3D model using the Face Expressions effect.Face LandmarksFace Landmarks are 93 points that are tracked with the user's face.Face StretchThe Face Stretch effect allows you to stretch points of the user's face.2D Head ArtThe 2D Head Art asset provides a base for creating Face Lenses that attach 2D art to your head.Face In VideoThe Face In Video example allows you to attach your own content to a video using tracking data from After Effects.
All APIs in this topic
Add components to a scene object, reference assets and other modules with a script input, require modules with require('LensStudio:<name>'), and create events with script.createEvent('<name>').
Components, assets, and modules
| API | Description |
|---|---|
| EyeColorVisual | Applies an eye color effect to a face. |
| FaceInsetVisual | Provides a 2D visual of a section of a tracked face, such as Mouth, Nose, etc. |
| FaceMaskVisual | Maps a 2D texture to the user's face. |
| FaceStretchVisual | Used to apply deformation effects to specific regions of a tracked face. |
| FaceTrackingModule | Declares the face tracking permission for your Lens project. |
| FaceTrackingScope | The face that a tracker should use. |
| Head | Used to move and rotate SceneObjects in sync with the user's head movements. |
| RetouchVisual | Adds subtle retouching effects to detected faces such as soft skin, teeth whitening, etc. |
Events
| API | Description |
|---|---|
| BrowsLoweredEvent | Triggered when eyebrows are lowered on the tracked face. |
| BrowsRaisedEvent | Triggered when eyebrows are raised on the tracked face. |
| BrowsReturnedToNormalEvent | Triggered when eyebrows are returned to normal on the tracked face. |
| FaceFoundEvent | Triggered when a new face is detected and starts being tracked. |
| FaceLostEvent | Triggered when a face can no longer be tracked. |
| FaceTrackingEvent | This is the base class for all face tracking events. |
| KissFinishedEvent | Triggered when the tracked face ends a kiss. |
| KissStartedEvent | Triggered when the tracked face starts a kiss. |
| MouthClosedEvent | Triggered when the tracked face's mouth closes. |
| MouthOpenedEvent | Triggered when the tracked face's mouth opens. |
| SmileFinishedEvent | Triggered when a smile ends on the tracked face. |
| SmileStartedEvent | Triggered when a smile begins on the tracked face. |
Objects and data
| API | Description |
|---|---|
| FaceCropTextureProvider | Texture Provider giving a cropped region of the input texture, calculated based on face position. |
| FaceRenderObjectProvider | Mesh provider for a Face Mesh. |
| NamedValues | A type containing two arrays which map positionally to each other. |
| StretchPoint | A point in the FaceStretchVisual feature. |
Enums
| API | Description |
|---|---|
| AttachmentPointType | |
| Expressions | |
| EyeToRender | Specifies which eye to apply an EyeColorVisual effect to. |
| FaceInsetRegion |