Skip to main content

Bitmoji3DResource

Class

Provides information about the current user's 3D Bitmoji avatar to be downloaded via the RemoteMediaModule.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Example

// @input Asset.BitmojiModule bitmojiModule
// @input Asset.RemoteMediaModule remoteMediaModule
// @input Asset.Material pbrMaterialHolder

script.bitmojiModule.requestBitmoji3DResource(
function (bitmoji3DResource) {
script.remoteMediaModule.loadResourceAsGltfAsset(
bitmoji3DResource,
onDownloaded,
onFail
)
}
)

function onDownloaded (gltfAsset){
var root = scene.createSceneObject("BitmojiAvatar");
var gltfSettings = GltfSettings.create();
gltfSettings.convertMetersToCentimeters = true;
var avatar = gltfAsset.tryInstantiateWithSetting(root, script.pbrMaterialHolder, gltfSettings);
}

function onFail (e){
print(e);
}

Extends

Methods

createWithBuffer()

static createWithBuffer(buffer): DynamicResource

Create a DynamicResource based on a Uint8Array. Can then be used to load that buffer as one of various Asset types using RemoteMediaModule.

Parameters

ParameterType
bufferUint8Array

Returns

DynamicResource

Since

Lens Scripting Version 173

Inherited from

DynamicResource.createWithBuffer


getTypeName()

static getTypeName(): TypeName<Bitmoji3DResource>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<Bitmoji3DResource>

Overrides

DynamicResource.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

DynamicResource.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

DynamicResource.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

DynamicResource.isSame