Skip to main content

FileLicensedSoundProvider

Class

A file track provider of the Licensed Sounds from Asset LIbrary.

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

Since Lens Scripting v158

Index

Example

//@input Asset.AudioTrackAsset audioTrack

var control = script.audioTrack.control;
var sampleRate = control.sampleRate;
var audioBuffer = new Float32Array(control.maxFrameSize);
control.loops = -1;

script.createEvent("UpdateEvent").bind(function (eventData) {
var readSize = eventData.getDeltaTime() * sampleRate;
control.getAudioBuffer(audioBuffer, readSize);
});

Extends

Properties

duration

readonly duration: number

The duration of the AudioTrackAsset in seconds.

Since

Lens Scripting Version 158


loops

loops: number

Loop count, if -1 is provided, the audio track will loop forever.

Since

Lens Scripting Version 158

Default Value

1

maxFrameSize

readonly maxFrameSize: number

The maximum frame size of the audio track asset.

Since

Lens Scripting Version 145

Inherited from

AudioTrackProvider.maxFrameSize


sampleRate

sampleRate: number

Sample rate (samples per second) of the audio track asset.

Since

Lens Scripting Version 145

Inherited from

AudioTrackProvider.sampleRate

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());

Inherited from

AudioTrackProvider.ensureLoaded


getAudioBuffer()

getAudioBuffer(audioBuffer, readSize): vec3

Writes readSize samples into the passed in audioBuffer Float32Array.

Parameters

ParameterType
audioBufferFloat32Array
readSizenumber

Returns

vec3

Since

Lens Scripting Version 163


getAudioFrame()

getAudioFrame(audioFrame): vec3

Writes current audio frame to the passed in Float32Array and returns the frame shape.

Parameters

ParameterType
audioFrameFloat32Array

Returns

vec3

Since

Lens Scripting Version 158


getLoadStatus()

getLoadStatus(): LoadStatus

Returns

LoadStatus

Inherited from

AudioTrackProvider.getLoadStatus


getTypeName()

static getTypeName(): TypeName<FileLicensedSoundProvider>

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

Since

Lens Scripting Version 158

Overrides

AudioTrackProvider.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

AudioTrackProvider.isSame