Face Events

Inputs

enableHintboolean

Shows a system hint (on screen instruction) for the relevant interaction for face events, true by default unless the lens shows it's own hint through text or another means.

Events

onFaceFound

this event is triggered when a face is found in the image and is being tracked

onFaceLost

This event is being triggered when a tracked face is lost

onMouthOpened

This event is being triggered when the user opens the mouth

onMouthClosed

This event is being triggered when the user closes the mouth

onSmileStarted

This event is triggered when the user smiles

onSmileFinished

Event is triggered when the user stops smiling

onKissStarted

This event is triggered when a kiss starts

onKissFinished

Event is triggered when a kiss is finished

onBrowsRaised

This event is triggered when the user raise the eyebrows

onBrowsLowered

This event is triggered when a user lowers the eyebrows

onBrowsNormal

This event is triggered when a user returns the eyebrows to a normal (natural) position

onTiltLeft

An event called when the user tilts their head to the left. Use this or onTiltRight if a user requests changing something using head tilt.

onTiltRight

An event called when the user tilts their head to the right. Use this or onTiltLeft if a user requests changing something using head tilt.

onTiltCenter

An event called when the user re-centers their head after tilting it to one side.

Functions

getHeadAnglefloat

Gets the head tilt angle ranging from 0 to 90.0 when the user tilts left and 0 to -90.0 when the user tilts to the right.

getNosePosition2Dvec2

Gets the 2D nose position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

getLeftEyePosition2Dvec2

Gets the 2D left eye position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

getRightEyePosition2Dvec2

Gets the 2D right eye position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

getMouthPosition2Dvec2

Gets the 2D mouth position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

getHeadCenterPosition2Dvec2

Gets the 2D head center position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

getForeheadPosition2Dvec2

Gets the 2D forehead position of the user in screen space as a vec2 ranging from (0.0,0.0) - top left corner to (1.0,1.0) - bottom right corner.

More in Camera, Audio & Sensors

• Device CameraGives your Lens the camera picture, live or frozen as a still. Your Lens can show that picture on a surface, or keep the still to use later.
• Face MLChanges your face with one ready-made effect, for example an anime look, a meme grin or a skull. Say the look you want, and your Lens keeps that one effect.
• FaceLandmarksFollows where your eyes, nose, mouth and forehead are, so a sticker or text can sit on them and move with you. Ask for hearts on your eyes.
• GyroscopeTurns tilting and shaking your phone into a control for your Lens. Ask for a tilt game, for example a maze where you roll a ball to the exit.
• Hand TrackingFollows your hands and reads gestures like a fist, a pinch, a thumbs up or a peace sign. Ask for something your hand controls, for example drawing with a pinch.
• HapticsMakes your phone vibrate at the moments you choose. Ask for a buzz when you tap the screen or score a point.
• Picture in PicturePuts a frame with the live camera on the screen, with or without a border. Tap the frame to swap in a photo from your device.
• Selfie WidgetShows a small live camera view on the screen, as a circle or a rectangle. Choose where it sits and how big it is, for example in the corner of a game.
• SoundPlays a sound in the Lens. Add the sound you want, and the Lens can start it, pause it and resume it.
• Touch EventsAdds tap, drag and swipe controls, so you touch the screen to control the Lens. Say what each touch does, for example tap to drop a coin.
• Voice ChangerChanges your voice while you speak. Ask for the effect you want, for example a deep voice, a robot, an alien or an echo.
• ZoomZooms the view in on any point of the screen, smoothly or held in place the whole time. Say where to zoom, how close, and whether it repeats back and forth.