Bitmoji 3D
Install and use the Bitmoji 3D asset package to download and display 3D avatars in SPECS Lenses, including multiplayer with Sync Kit.
- Snapchat: not supported
- SPECS: fully supported
- Camera Kit Web: not supported
- Camera Kit Mobile: not supported
- SnapchatNot supported
- SPECSFully supported
- Camera Kit WebNot supported
- Camera Kit MobileNot supported
The Bitmoji 3D package downloads and displays 3D Bitmoji avatars in SPECS Lenses.
Prerequisites
- Lens Studio v5.15.0 or later
- SnapOS v5.63.x or later
- Bitmoji 3D package (available in Asset Library)
Installation
- Open your SPECS project in Lens Studio
- Navigate to Asset Library
- Search for "Bitmoji 3D"
- Click "Install" to add the package to your project
Connected Lenses Usage
Bitmoji 3D can be used with Sync Kit to display avatars for users in a Connected Lens session. Retrieve the SpecsUser object from the active session, then download and instantiate the Bitmoji avatar using the steps below.
Setup
- Install Bitmoji 3D and Sync Kit from Asset Library
- Follow the Sync Kit documentation to set up your multiplayer session
- Add a Bitmoji 3D component to your scene
- Configure it: Set Bitmoji Type to "None" and disable Auto Download
- Create a script and reference the Bitmoji component as an input
Code Example
Step 1: Get SpecsUser from Connection ID
- TypeScript
- JavaScript
private getSpecsUserByConnectionId(
connectionId: string
): Promise<SpecsUser> {
return new Promise((resolve, reject) => {
const session = this.sessionController.getSession();
const matchingUserInfo = session.activeUsersInfo.find(
(userInfo) => userInfo && userInfo.connectionId === connectionId
);
if (matchingUserInfo) {
this.sessionController.getSpecsUser(matchingUserInfo, (user) =>
user ? resolve(user) : reject(`No SpecsUser for ${connectionId}`)
);
print(
`Found user ${matchingUserInfo.displayName} for connection ID ${connectionId}`
);
} else {
reject(`User ${connectionId} not found in active users`);
}
});
}
function getSpecsUserByConnectionId(connectionId) {
return new Promise(function (resolve, reject) {
var session = script.sessionController.getSession();
var matchingUserInfo = session.activeUsersInfo.find(function (userInfo) {
return userInfo && userInfo.connectionId === connectionId;
});
if (matchingUserInfo) {
script.sessionController.getSpecsUser(matchingUserInfo, function (user) {
if (user) {
resolve(user);
} else {
reject('No SpecsUser for ' + connectionId);
}
});
} else {
reject('User ' + connectionId + ' not found in active users');
}
});
}
Step 2: Download Avatar for User
- TypeScript
- JavaScript
private async loadPlayerBitmoji(connectionId: string) {
try {
const user = await this.getSpecsUserByConnectionId(connectionId);
await this.bitmojiComponent.downloadAvatarForUser(user);
const avatar = this.bitmojiComponent.getAvatar();
if (avatar) {
print('Bitmoji loaded successfully!');
}
} catch (e) {
print(`Error loading bitmoji: ${e}`);
}
}
async function loadPlayerBitmoji(connectionId) {
try {
var user = await getSpecsUserByConnectionId(connectionId);
await script.bitmojiComponent.downloadAvatarForUser(user);
var avatar = script.bitmojiComponent.getAvatar();
if (avatar) {
print('Bitmoji loaded successfully!');
}
} catch (e) {
print('Error loading bitmoji: ' + e);
}
}
Step 3: Full Example
- TypeScript
- JavaScript
import { SessionController } from 'SyncKit.lspkg/Core/SessionController';
import { Bitmoji3D } from 'Bitmoji 3D.lsc/Bitmoji 3D.lsc/Bitmoji 3D';
@component
export class ConnectedLensBitmoji extends BaseScriptComponent {
private sessionController: SessionController =
SessionController.getInstance();
@input
bitmojiComponent: Bitmoji3D;
onAwake() {
this.sessionController.notifyOnReady(() => {
const connectionId = this.sessionController.getLocalConnectionId();
this.getSpecsUserByConnectionId(connectionId);
this.loadPlayerBitmoji(connectionId);
});
}
private getSpecsUserByConnectionId(
connectionId: string
): Promise<SpecsUser> {
return new Promise((resolve, reject) => {
const session = this.sessionController.getSession();
const matchingUserInfo = session.activeUsersInfo.find(
(userInfo) => userInfo && userInfo.connectionId === connectionId
);
if (matchingUserInfo) {
this.sessionController.getSpecsUser(matchingUserInfo, (user) =>
user ? resolve(user) : reject(`No SpecsUser for ${connectionId}`)
);
print(
`Found user ${matchingUserInfo.displayName} for connection ID ${connectionId}`
);
} else {
reject(`User ${connectionId} not found in active users`);
}
});
}
private async loadPlayerBitmoji(connectionId: string) {
try {
const user = await this.getSpecsUserByConnectionId(connectionId);
await this.bitmojiComponent.downloadAvatarForUser(user);
const avatar = this.bitmojiComponent.getAvatar();
if (avatar) {
print('Bitmoji loaded successfully!');
}
} catch (e) {
print(`Error loading bitmoji: ${e}`);
}
}
}
const SessionController =
require('SyncKit.lspkg/Core/SessionController').SessionController;
//@input Component.ScriptComponent bitmojiComponent
script.sessionController = SessionController.getInstance();
script.sessionController.notifyOnReady(function () {
var connectionId = script.sessionController.getLocalConnectionId();
getSpecsUserByConnectionId(connectionId);
loadPlayerBitmoji(connectionId);
});
function getSpecsUserByConnectionId(connectionId) {
return new Promise(function (resolve, reject) {
var session = script.sessionController.getSession();
var matchingUserInfo = session.activeUsersInfo.find(function (userInfo) {
return userInfo && userInfo.connectionId === connectionId;
});
if (matchingUserInfo) {
script.sessionController.getSpecsUser(matchingUserInfo, function (user) {
if (user) {
resolve(user);
} else {
reject('No SpecsUser for ' + connectionId);
}
});
} else {
reject('User ' + connectionId + ' not found in active users');
}
});
}
async function loadPlayerBitmoji(connectionId) {
try {
var user = await getSpecsUserByConnectionId(connectionId);
await script.bitmojiComponent.downloadAvatarForUser(user);
var avatar = script.bitmojiComponent.getAvatar();
if (avatar) {
print('Bitmoji loaded successfully!');
}
} catch (e) {
print('Error loading bitmoji: ' + e);
}
}
Privacy & Friendship: If users are not Snapchat friends or have Bitmoji privacy restrictions enabled, a randomized Bitmoji will be loaded instead of their actual avatar.