Skip to main content

MLAsset

Class

Represents a machine learning model that can be integrated with an MLComponent.

  • 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.MLAsset model

var mlComponent = script.sceneObject.createComponent('MLComponent');
mlComponent.model = script.model;

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

BinAsset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

BinAsset.uniqueIdentifier

Methods

getMetadata()

getMetadata(): any

Returns model metadata as JSON object.

Returns

any

Since

Lens Scripting Version 167


getTypeName()

static getTypeName(): TypeName<MLAsset>

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<MLAsset>

Overrides

BinAsset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BinAsset.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

BinAsset.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

BinAsset.isSame