Key Press Events

Events

onKeyPressed

Event fired when a key is pressed. Payload: `{ key: Keys, modifiers: KeyModifiers[] }`. Repeats while a key is held (OS key-repeat).

onKeyReleased

Event fired when a key is released. Payload: `{ key: Keys, modifiers: KeyModifiers[] }` (same shape as `onKeyPressed`).

Functions

isKeyPressedboolean

Returns `true` while `key` (a `Keys` value) is held down.

getPressedKeysObject

Returns the `Keys[]` currently held down.

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 EventsMakes your Lens react when you open your mouth, smile, kiss, raise your eyebrows or tilt your head. It also tells the Lens where your eyes, nose and mouth are on screen.
• 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.