Preparing search index...

    Class AudioOutputProvider

    Provider of the Audio Output Audio Track asset.

    Lens Scripting Version 147

    // @input Asset.AudioTrackAsset audioOutput
    audioOutput = script.audioOutput.control;
    audioOutput.sampleRate = script.sampleRate;

    Hierarchy (View Summary)

    Index

    Properties

    maxFrameSize: number

    The maximum frame size of the audio track asset.

    Lens Scripting Version 145

    sampleRate: number

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

    Lens Scripting Version 145

    Methods

    • Enqueue audio data into an audio playback system.

      shape.x - buffer size, must be less or equal to audioFrame length.

      Parameters

      • audioFrame: Float32Array
      • inShape: vec3

      Returns void

      Lens Scripting Version 147

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

      Returns Promise<void>

      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.

      Lens Scripting Version 370

      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());
    • Preferred size for audio output at the current frame update.

      Returns number

      Lens Scripting Version 147

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

      Lens Scripting Version 147

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean