Length of the animation in seconds.
Returns whether the animation was set to automatically play and loop.
If enabled, the animation will alternate between normal and reverse each time it loops.
Whether the animation plays in reverse.
The animation track used to control the frame animation.
Duplicates the AnimatedTextureFileProvider and returns the new copy. Can be used for playing the same animation at different offsets.
Returns a Promise that resolves once this Provider has finished loading its resource.
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.
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());
Returns the texture's aspect ratio, which is calculated as width / height.
Returns the index of the frame that is currently playing.
Returns how long the animation is in seconds.
Use AnimatedTextureFileProvider.duration instead.
Returns the number of frames in the animation.
Returns the height of the texture in pixels.
StaticgetReturns 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 the name of this object's type.
Returns the width of the texture in pixels.
Returns whether the animation is finished playing.
Returns true if the object matches or derives from the passed in type.
Returns whether the animation is currently paused.
Returns whether the animation is currently playing.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Pauses the animation.
Pauses the animation at frame frameIndex.
Plays the animation loops times, starting with an offset of offset seconds.
Start playing the animation from frame frameIndex, loops times.
Resumes a paused animation from the frame that was last played.
Sets the callback function to be called whenever the animation stops playing.
Stops the animation.
Provider for animated texture resource.
Remarks
Can be accessed from Texture.Control on an animated texture.
See
2D Animation Guide.
Example