@pixelverse/strichjs-sdk 1.7.2 → 1.7.4

package/dist/strich.d.ts

@@ -1,3 +1,29 @@
+/**
+ * Fine-grained audio feedback configuration object
+ */
+export declare interface AudioFeedbackConfiguration {
+    /**
+     * Toggle audible beep upon successful scan.
+     *
+     * @remarks
+     * Uses the WebAudio API to emit a "cash register"-like beep. Beeping is done on a best-effort
+     * basis and should not be relied upon. If the browser does not support the WebAudio API,
+     * beeping will not work, and no error will be thrown.
+     *
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * Explicitly set the AudioSession type used for audible feedback.
+     *
+     * See https://github.com/w3c/audio-session/blob/main/explainer.md#api-design for a list of acceptable values.
+     *
+     * By default, the value `transient` is used if the AudioSession API is available.
+     * Setting this value to `null` will disable setting the AudioSession type.
+     */
+    audioSessionType?: string | null;
+}
+
 /**
  * BarcodeReader is the primary interface of the STRICH SDK.
  */
@@ -234,9 +260,14 @@ export declare interface FeedbackConfiguration {
     /**
      * Toggle audible beep upon successful scan.
      *
+     * @remarks
+     * Uses the WebAudio API to emit a "cash register"-like beep. Beeping is done on a best-effort
+     * basis and should not be relied upon. If the browser does not support the WebAudio API, and in iOS
+     * PWAs, an HTML5 audio element will be used instead.
+     *
      * @defaultValue true
      */
-    audio?: boolean;
+    audio?: boolean | AudioFeedbackConfiguration;
     /**
      * Toggle vibration upon successful scan, if supported by device.
      *
@@ -748,6 +779,17 @@ export declare class StrichSDK {
      * @param lang - The lower-case ISO language code, e.g. 'en'
      */
     static setLanguage(lang: string): void;
+    /**
+     * Override the preferred audio implementation used to emit audible feedback (beeps). By default, the SDK will
+     * automatically select an appropriate implementation.
+     *
+     * @remarks
+     * Using this method should only be necessary in specialized environments.
+     * Selecting an unsupported implementation will still fall back to an available one.
+     *
+     * @param impl - The audio implementation to use, either 'webaudio' for the WebAudio API, or 'html5' for an HTML5 Audio element
+     */
+    static setAudioImpl(impl: 'webaudio' | 'html5'): void;
     /**
      * Check if the browser has access to a camera device, which is required for scanning barcodes.
      *