Skip to main content

NativeLibraryAsset

Class

NativeLibraryAsset loads a native shared library (e.g. .so, .dylib, .dll) and exposes its exports to JavaScript.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v364

NativeLibraryAsset loads a native shared library (e.g. .so, .dylib, .dll) and exposes its exports to JavaScript.

Index

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Asset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier

Methods

getTypeName()

static getTypeName(): TypeName<NativeLibraryAsset>

SPECS

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

Since

Lens Scripting Version 364

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

Asset.isSame


load()

load(): Promise<any>

SPECS

Loads the native library specified by the library property and returns the exports Object. Multiple calls to this method will return the same Object until unload() is called.

Returns

Promise<any>

Since

Lens Scripting Version 364


unload()

unload(): Promise<void>

SPECS

Unloads the native library and releases the exports Object. It is undefined behavior to call any functions on the exports Object after calling this method.

Returns

Promise<void>

Since

Lens Scripting Version 364