@mediapipe/tasks-audio 0.10.4 → 0.10.6

package/audio.d.ts

@@ -3,6 +3,7 @@ export declare class AudioClassifier extends AudioTaskRunner<AudioClassifierResu
     /**
      * Initializes the Wasm runtime and creates a new audio classifier from the
      * provided options.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param audioClassifierOptions The options for the audio classifier. Note
@@ -13,6 +14,7 @@ export declare class AudioClassifier extends AudioTaskRunner<AudioClassifierResu
     /**
      * Initializes the Wasm runtime and creates a new audio classifier based on
      * the provided model asset buffer.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetBuffer A binary representation of the model.
@@ -21,6 +23,7 @@ export declare class AudioClassifier extends AudioTaskRunner<AudioClassifierResu
     /**
      * Initializes the Wasm runtime and creates a new audio classifier based on
      * the path to the model asset.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetPath The path to the model asset.
@@ -34,6 +37,7 @@ export declare class AudioClassifier extends AudioTaskRunner<AudioClassifierResu
      * You can reset an option back to its default value by explicitly setting it
      * to `undefined`.
      *
+     * @export
      * @param options The options for the audio classifier.
      */
     setOptions(options: AudioClassifierOptions): Promise<void>;
@@ -41,6 +45,7 @@ export declare class AudioClassifier extends AudioTaskRunner<AudioClassifierResu
      * Performs audio classification on the provided audio clip and waits
      * synchronously for the response.
      *
+     * @export
      * @param audioData An array of raw audio capture data, like from a call to
      *     `getChannelData()` on an AudioBuffer.
      * @param sampleRate The sample rate in Hz of the provided audio data. If not
@@ -76,6 +81,7 @@ export declare class AudioEmbedder extends AudioTaskRunner<AudioEmbedderResult[]
     /**
      * Initializes the Wasm runtime and creates a new audio embedder from the
      * provided options.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param audioEmbedderOptions The options for the audio embedder. Note that
@@ -86,6 +92,7 @@ export declare class AudioEmbedder extends AudioTaskRunner<AudioEmbedderResult[]
     /**
      * Initializes the Wasm runtime and creates a new audio embedder based on the
      * provided model asset buffer.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetBuffer A binary representation of the TFLite model.
@@ -94,6 +101,7 @@ export declare class AudioEmbedder extends AudioTaskRunner<AudioEmbedderResult[]
     /**
      * Initializes the Wasm runtime and creates a new audio embedder based on the
      * path to the model asset.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetPath The path to the TFLite model.
@@ -107,6 +115,7 @@ export declare class AudioEmbedder extends AudioTaskRunner<AudioEmbedderResult[]
      * You can reset an option back to its default value by explicitly setting it
      * to `undefined`.
      *
+     * @export
      * @param options The options for the audio embedder.
      */
     setOptions(options: AudioEmbedderOptions): Promise<void>;
@@ -114,6 +123,7 @@ export declare class AudioEmbedder extends AudioTaskRunner<AudioEmbedderResult[]
      * Performs embeding extraction on the provided audio clip and waits
      * synchronously for the response.
      *
+     * @export
      * @param audioData An array of raw audio capture data, like from a call to
      *     `getChannelData()` on an AudioBuffer.
      * @param sampleRate The sample rate in Hz of the provided audio data. If not
@@ -152,6 +162,7 @@ declare abstract class AudioTaskRunner<T> extends TaskRunner {
      * Sets the sample rate for API calls that omit an explicit sample rate.
      * `48000` is used as a default if this method is not called.
      *
+     * @export
      * @param sampleRate A sample rate (e.g. `44100`).
      */
     setDefaultSampleRate(sampleRate: number): void;
@@ -380,12 +391,14 @@ export declare class FilesetResolver {
      * you can use `isSimdSupported()` to decide whether to load the SIMD-based
      * assets.
      *
+     * @export
      * @return Whether SIMD support was detected in the current environment.
      */
     static isSimdSupported(): Promise<boolean>;
     /**
      * Creates a fileset for the MediaPipe Audio tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -396,6 +409,7 @@ export declare class FilesetResolver {
     /**
      * Creates a fileset for the MediaPipe Text tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -406,6 +420,7 @@ export declare class FilesetResolver {
     /**
      * Creates a fileset for the MediaPipe Vision tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -420,7 +435,10 @@ declare abstract class TaskRunner {
     protected constructor();
     /** Configures the task with custom options. */
     abstract setOptions(options: TaskRunnerOptions): Promise<void>;
-    /** Closes and cleans up the resources held by this task. */
+    /**
+     * Closes and cleans up the resources held by this task.
+     * @export
+     */
     close(): void;
 }
 
@@ -453,6 +471,8 @@ declare interface WasmFileset {
     wasmBinaryPath: string;
     /** The optional path to the asset loader script. */
     assetLoaderPath?: string;
+    /** The optional path to the assets binary. */
+    assetBinaryPath?: string;
 }
 
 export { }