Skip to main content

Provider

Class

Base class for all resource providers.

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

Base class for all resource providers. Providers are the implementation for Asset.

Index

Remarks

For example: VideoTextureProvider is the implementation for a Texture backed by a video file.

Example

In most cases, providers can be accessed via the control property of an asset.

For example, we can jump to the last frame of an animated texture:

// @input Asset.Texture myAnimatedTexture
const myAnimatedTextureProvider = script.myAnimatedTexture.control;
const frameCountOfTexture = myAnimatedTextureProvider.getFramesCount();
myAnimatedTextureProvider.pauseAtFrame(frameCountOfTexture - 1);

Or do it in TypeScript:

@component
export class ProviderExample extends BaseScriptComponent {
@input()
myAnimatedTexture: Texture;

onAwake() {
const myAnimatedTextureProvider = this.myAnimatedTexture.control as AnimatedTextureFileProvider;
const frameCountOfTexture = myAnimatedTextureProvider.getFramesCount();
myAnimatedTextureProvider.pauseAtFrame(frameCountOfTexture - 1);
}
}

Extends

Extended by

Methods

ensureLoaded()

ensureLoaded(): Promise<void>

Returns a Promise that resolves once this Provider has finished loading its resource.

Returns

Promise<void>

Remarks

If the Provider is already loaded when ensureLoaded() is called, the returned Promise resolves immediately. Otherwise it resolves once loading completes.

Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.

This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.

Since

Lens Scripting Version 370

Example

Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:

const internetModule = require("LensStudio:InternetModule");
const remoteMediaModule = require("LensStudio:RemoteMediaModule");

function loadImageTexture(url) {
const resource = internetModule.makeResourceFromUrl(url);
return new Promise((resolve, reject) => {
remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
});
}

const texture = await loadImageTexture("https://example.com/image.png");

// Wait until the fetched Texture's Provider has finished loading before using it.
await texture.control.ensureLoaded();
print("Texture ready, loadStatus: " + texture.control.getLoadStatus());

getLoadStatus()

getLoadStatus(): LoadStatus

Returns

LoadStatus


getTypeName()

static getTypeName(): TypeName<Provider>

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

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

ScriptObject.isSame