Bitmoji Head

Inputs

headTypestring

Specifies the Bitmoji avatar type. Accepts two values: "User" or "Friend". "User" displays the user's Bitmoji head, while "Friend" displays a friend's Bitmoji head.

headIndexint

Defines which head to use for facial expression tracking and, if "attachToHead" is true, which head to attach to. Index starts at 0. The maximum supported value is 3.

friendIndexint

Selects which friend's Bitmoji to show when "headType" is set to "Friend". The value starts at 0, where 0 means the friend the user interacted with most recently, 1 means the next one, and so on. This value is ignored if "headType" is "User".

attachToHeadboolean

If true Bitmoji Head is attached to the user's face. If false Bitmoji Head is placed freely in the scene.

offsetvec2

Defines the Bitmoji Head's offset position. When Bitmoji Head is attached to the user's face, the offset is applied relative to the user's face position. As a rough reference, the user's face typically spans from x: -15 to 15 and from y: -20 (chin) to 20 (forehead). When Bitmoji Head is not attached to the user's face, the offset is applied relative to the center of the screen, and scene bounds are approximately: x: -15 (left) to 15 (right), y: -20 (bottom) to 20 (top).

scalefloat

Defines the overall size of the Bitmoji head in the scene. The scale value should not exceed 3.0. When Bitmoji Head is attached to the user's face, a scale of 1.0 matches the size of the user's real head. When Bitmoji Head is not attached to the user's face, a scale of 1.0 displays the Bitmoji Head at a visually dominant size. Use ONLY type `number`

rotationvec3

Defines the Bitmoji Head's rotation.

rotateHeadboolean

Functions

getPosition2Dvec2

Gets the 2d screen position of the Bitmoji's head.

getSize2Dvec2

Gets the 2d screen size of the Bitmoji's head.

More in Bitmoji & Friends

• Bitmoji Animation StoreKeeps up to five Bitmoji moves ready, so your Bitmoji character can play them by name. Ask for the moves you want, for example wave, dance or jump.
• Bitmoji CharacterAdds your Bitmoji as a character you can move around in a game. It walks, runs and jumps, and it bumps into things in the scene.
• Bitmoji SceneAdds your animated Bitmoji to the Lens, with up to six in total including your friends. Say what each one wears and how it moves, for example a friend dancing in a red dress.
• Bitmoji Sticker StoreLoads 2D Bitmoji stickers of you and your friends, so the Lens can show them. Name the poses you want, for example a thumbs up or a laughing Bitmoji.
• Generative Bitmoji AnimationMakes your Bitmoji move with an animation you describe, or copies the movement from a video you give it. Only the movement carries over, not clothes or props.
• List of FriendsBrings your friends and their Bitmoji into the Lens, so a friend can appear on screen. Choose which friends: all of them, your best friends, or a random one.