FileAudioTrackProvider
ClassProvider for file based Audio Tracks.
- Available on all platforms
Since Lens Scripting v144
Index
Properties
Methods
Example
// @input Asset.AudioTrackAsset audioTrack
var control = script.audioTrack.control;
if (control.isOfType(FileAudioTrackProvider.getTypeName())) {
control.loops = -1; //set to loop forever
}
var audioFrameArray = new Float32Array(control.maxFrameSize)
script.script.createEvent("UpdateEvent").bind(function(eventData){
var frameShape = control.getAudioFrame(audioFrameArray);
print(frameShape.x + " samples were read on this update")
print(control.position + " current audio track position");
});
Extends
Properties
duration
readonlyduration:number
The duration of the AudioTrackAsset in seconds.
Since
Lens Scripting Version 145
loops
loops:
number
Loop count, if -1 is provided, the audio track will loop forever.
Since
Lens Scripting Version 149
Default Value
1
maxFrameSize
readonlymaxFrameSize:number
The maximum frame size of the audio track asset.
Since
Lens Scripting Version 145
Inherited from
AudioTrackProvider.maxFrameSize
position
position:
number
The current position of the AudioTrackAsset in seconds.
Since
Lens Scripting Version 145
sampleRate
sampleRate:
number
Sample rate (samples per second) of the audio track asset.
Since
Lens Scripting Version 145
Inherited from
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
| Parameter | Type |
|---|---|
audioBuffer | Float32Array |
readSize | number |
Returns
Since
Lens Scripting Version 153
getAudioFrame()
getAudioFrame(
audioFrame):vec3
Writes current audio frame to the passed in Float32Array and returns the frame shape.
Parameters
| Parameter | Type |
|---|---|
audioFrame | Float32Array |
Returns
Since
Lens Scripting Version 147
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
AudioTrackProvider.getLoadStatus
getTypeName()
staticgetTypeName():TypeName<FileAudioTrackProvider>
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<FileAudioTrackProvider>
Since
Lens Scripting Version 144
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
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean