@capgo/capacitor-speech-recognition 8.1.7 → 8.1.8

package/README.md

@@ -567,6 +567,7 @@ Configure how the recognizer behaves when calling {@link SpeechRecognitionPlugin
 | **`useOnDeviceRecognition`** | <code>boolean</code>  | Opt in to the platform's newer on-device recognition path when available. On iOS 26+, this uses Apple's `SpeechAnalyzer` / `SpeechTranscriber` pipeline. On recent Android versions, this uses the on-device `SpeechRecognizer` path. It is intentionally opt-in so existing apps keep the legacy flow unless they choose to roll out the new behavior. On iOS, leaving this disabled keeps `SFSpeechRecognizer` on every supported OS version. Enabling it on older iOS versions or unsupported locales falls back to `SFSpeechRecognizer`. Use {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable} before enabling it in production. Platform SDK docs: iOS: [Speech](https://developer.apple.com/documentation/speech), [SpeechAnalyzer](https://developer.apple.com/documentation/speech/speechanalyzer), [SpeechTranscriber](https://developer.apple.com/documentation/speech/speechtranscriber) Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer) Defaults to `false`. |
 | **`allowForSilence`**        | <code>number</code>   | Allow a number of milliseconds of silence before splitting the recognition session into segments. Required to be greater than zero and currently supported on Android only.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | **`continuousPTT`**          | <code>boolean</code>  | EXPERIMENTAL: Keep a PTT session alive across silence by restarting recognition while the button stays held. This restart behavior is implemented for Android inline recognition and iOS native recognition.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| **`muteRecognizerBeep`**     | <code>boolean</code>  | Suppresses the Android system beep when inline recognition starts or restarts. Uses a best-effort combination of an undocumented recognizer intent extra and temporary notification/system stream volume muting. Some devices ignore the intent extra; the volume fallback is the portable path. Defaults to `true` when `continuousPTT` is enabled.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
 
 #### SpeechRecognitionMatches
@@ -600,9 +601,10 @@ Result from {@link SpeechRecognitionPlugin.getLastPartialResult}.
 
 Options for {@link SpeechRecognitionPlugin.setPTTState}.
 
-| Prop       | Type                 | Description                               |
-| ---------- | -------------------- | ----------------------------------------- |
-| **`held`** | <code>boolean</code> | Whether the PTT button is currently held. |
+| Prop       | Type                 | Description                                                                                                                                                                                                                                                         |
+| ---------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`held`** | <code>boolean</code> | Whether the PTT button is currently held.                                                                                                                                                                                                                           |
+| **`mute`** | <code>boolean</code> | When set, updates whether Android should suppress the recognizer start beep for the active session. Beep suppression is best-effort and device-specific; see {@link <a href="#speechrecognitionstartoptions">SpeechRecognitionStartOptions.muteRecognizerBeep</a>}. |
 
 
 #### SpeechRecognitionLanguages

package/android/src/main/java/app/capgo/speechrecognition/Constants.java

@@ -16,4 +16,5 @@ public interface Constants {
     String READY_FOR_NEXT_SESSION_EVENT = "readyForNextSession";
     String RECORD_AUDIO_PERMISSION = Manifest.permission.RECORD_AUDIO;
     String LANGUAGE_ERROR = "Could not get list of languages";
+    String EXTRA_DICTATE_BEEP = "android.speech.extra.DICTATE_BEEP";
 }

package/android/src/main/java/app/capgo/speechrecognition/SpeechRecognitionPlugin.java

@@ -2,7 +2,9 @@ package app.capgo.speechrecognition;
 
 import android.Manifest;
 import android.app.Activity;
+import android.content.Context;
 import android.content.Intent;
+import android.media.AudioManager;
 import android.os.Build;
 import android.os.Bundle;
 import android.os.Handler;
@@ -64,6 +66,10 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
     private boolean forceStopped = false;
     private boolean pttButtonHeld = false;
     private boolean continuousPTTMode = false;
+    private boolean muteRecognizerBeep = false;
+    private Integer savedNotificationVolume;
+    private Integer savedSystemVolume;
+    private long mutedForGeneration = -1;
     private boolean popupSessionActive = false;
     private boolean popupSessionCancelled = false;
     private StringBuilder accumulatedResults = new StringBuilder();
@@ -164,6 +170,7 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
         boolean useOnDeviceRecognition = call.getBoolean("useOnDeviceRecognition", false);
         int allowForSilence = call.getInt("allowForSilence", 0);
         boolean continuousPTT = call.getBoolean("continuousPTT", false);
+        boolean muteRecognizerBeepOption = call.getBoolean("muteRecognizerBeep", continuousPTT);
 
         if (useOnDeviceRecognition && popup) {
             call.reject("On-device recognition is not supported with popup mode on Android.");
@@ -198,6 +205,7 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
             resetPartialResultsCache();
             accumulatedResults = new StringBuilder();
             continuousPTTMode = continuousPTT;
+            muteRecognizerBeep = muteRecognizerBeepOption;
             popupSessionActive = false;
             popupSessionCancelled = false;
             lastLanguage = language;
@@ -409,6 +417,9 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
         try {
             lock.lock();
             pttButtonHeld = held;
+            if (call.getData().has("mute")) {
+                muteRecognizerBeep = call.getBoolean("mute");
+            }
             if (held) {
                 accumulatedResults = new StringBuilder();
                 forceStopped = false;
@@ -596,6 +607,11 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
             intent.putExtra(RecognizerIntent.EXTRA_PROMPT, prompt);
         }
 
+        // EXTRA_DICTATE_BEEP is undocumented and ignored on some devices; AudioManager fallback handles those.
+        if (muteRecognizerBeep) {
+            intent.putExtra(EXTRA_DICTATE_BEEP, false);
+        }
+
         return intent;
     }
 
@@ -722,7 +738,29 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
     }
 
     private void startInlineListening(Intent intent, boolean partialResults, PluginCall call, long currentSessionId, boolean restarting) {
+        final long muteGeneration;
+        try {
+            lock.lock();
+            muteGeneration = recognizerGeneration;
+            muteRecognizerBeepIfNeededLocked(muteGeneration);
+        } finally {
+            lock.unlock();
+        }
         speechRecognizer.startListening(intent);
+        handler.postDelayed(
+            () -> {
+                try {
+                    lock.lock();
+                    if (currentSessionId != sessionId) {
+                        return;
+                    }
+                    restoreRecognizerBeepIfNeededLocked(muteGeneration);
+                } finally {
+                    lock.unlock();
+                }
+            },
+            750
+        );
         listening(true);
         state = ListeningState.STARTED;
         emitListeningState("started", currentSessionId, restarting ? "results" : "userStart", null, "started");
@@ -781,6 +819,7 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
 
                 cancelPendingForceStopLocked();
                 listening(false);
+                restoreRecognizerBeepIfNeededLocked(mutedForGeneration);
                 if (activeStartCall != null && !lastPartialResults && ("userStop".equals(reason) || "forceStop".equals(reason))) {
                     startCallToReject = activeStartCall;
                 }
@@ -972,6 +1011,7 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
         handler.removeCallbacksAndMessages(null);
         try {
             lock.lock();
+            restoreRecognizerBeepIfNeededLocked(mutedForGeneration);
             destroyCurrentRecognizerLocked();
             activeStartCall = null;
             pendingStopReason = null;
@@ -984,6 +1024,51 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
         }
     }
 
+    private void muteRecognizerBeepIfNeededLocked(long generation) {
+        if (!muteRecognizerBeep) {
+            return;
+        }
+
+        AudioManager audioManager = (AudioManager) getContext().getSystemService(Context.AUDIO_SERVICE);
+        if (audioManager == null) {
+            return;
+        }
+
+        try {
+            if (savedNotificationVolume == null) {
+                savedNotificationVolume = audioManager.getStreamVolume(AudioManager.STREAM_NOTIFICATION);
+                savedSystemVolume = audioManager.getStreamVolume(AudioManager.STREAM_SYSTEM);
+                mutedForGeneration = generation;
+            }
+            audioManager.setStreamVolume(AudioManager.STREAM_NOTIFICATION, 0, 0);
+            audioManager.setStreamVolume(AudioManager.STREAM_SYSTEM, 0, 0);
+        } catch (SecurityException ex) {
+            Logger.warn(TAG, "Unable to mute recognizer beep: " + ex.getMessage());
+        }
+    }
+
+    private void restoreRecognizerBeepIfNeededLocked(long generation) {
+        if (savedNotificationVolume == null || generation != mutedForGeneration) {
+            return;
+        }
+
+        AudioManager audioManager = (AudioManager) getContext().getSystemService(Context.AUDIO_SERVICE);
+        if (audioManager != null) {
+            try {
+                audioManager.setStreamVolume(AudioManager.STREAM_NOTIFICATION, savedNotificationVolume, 0);
+                if (savedSystemVolume != null) {
+                    audioManager.setStreamVolume(AudioManager.STREAM_SYSTEM, savedSystemVolume, 0);
+                }
+            } catch (SecurityException ex) {
+                Logger.warn(TAG, "Unable to restore recognizer beep volume: " + ex.getMessage());
+            }
+        }
+
+        savedNotificationVolume = null;
+        savedSystemVolume = null;
+        mutedForGeneration = -1;
+    }
+
     private class SpeechRecognitionListener implements RecognitionListener {
 
         private final long listenerSessionId;
@@ -1005,7 +1090,17 @@ public class SpeechRecognitionPlugin extends Plugin implements Constants {
         }
 
         @Override
-        public void onReadyForSpeech(Bundle params) {}
+        public void onReadyForSpeech(Bundle params) {
+            if (isStale()) {
+                return;
+            }
+            try {
+                lock.lock();
+                restoreRecognizerBeepIfNeededLocked(listenerGeneration);
+            } finally {
+                lock.unlock();
+            }
+        }
 
         @Override
         public void onBeginningOfSpeech() {}

package/dist/docs.json

@@ -421,6 +421,13 @@
           "docs": "EXPERIMENTAL: Keep a PTT session alive across silence by restarting recognition while the button stays held.\n\nThis restart behavior is implemented for Android inline recognition and iOS native recognition.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "muteRecognizerBeep",
+          "tags": [],
+          "docs": "Suppresses the Android system beep when inline recognition starts or restarts.\n\nUses a best-effort combination of an undocumented recognizer intent extra and\ntemporary notification/system stream volume muting. Some devices ignore the\nintent extra; the volume fallback is the portable path.\n\nDefaults to `true` when `continuousPTT` is enabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -499,6 +506,13 @@
           "docs": "Whether the PTT button is currently held.",
           "complexTypes": [],
           "type": "boolean"
+        },
+        {
+          "name": "mute",
+          "tags": [],
+          "docs": "When set, updates whether Android should suppress the recognizer start beep for the active session.\n\nBeep suppression is best-effort and device-specific; see {@link SpeechRecognitionStartOptions.muteRecognizerBeep}.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -81,6 +81,16 @@ export interface SpeechRecognitionStartOptions {
      * This restart behavior is implemented for Android inline recognition and iOS native recognition.
      */
     continuousPTT?: boolean;
+    /**
+     * Suppresses the Android system beep when inline recognition starts or restarts.
+     *
+     * Uses a best-effort combination of an undocumented recognizer intent extra and
+     * temporary notification/system stream volume muting. Some devices ignore the
+     * intent extra; the volume fallback is the portable path.
+     *
+     * Defaults to `true` when `continuousPTT` is enabled.
+     */
+    muteRecognizerBeep?: boolean;
 }
 /**
  * Raised whenever a partial transcription is produced.
@@ -215,6 +225,12 @@ export interface PTTStateOptions {
      * Whether the PTT button is currently held.
      */
     held: boolean;
+    /**
+     * When set, updates whether Android should suppress the recognizer start beep for the active session.
+     *
+     * Beep suppression is best-effort and device-specific; see {@link SpeechRecognitionStartOptions.muteRecognizerBeep}.
+     */
+    mute?: boolean;
 }
 export interface SpeechRecognitionPlugin {
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Permission map returned by `checkPermissions` and `requestPermissions`.\n *\n * On Android the state maps to the `RECORD_AUDIO` permission.\n * On iOS it combines speech recognition plus microphone permission.\n */\nexport interface SpeechRecognitionPermissionStatus {\n  speechRecognition: PermissionState;\n}\n\n/**\n * Configure how the recognizer behaves when calling {@link SpeechRecognitionPlugin.start}.\n */\nexport interface SpeechRecognitionStartOptions {\n  /**\n   * Locale identifier such as `en-US`. When omitted the device language is used.\n   */\n  language?: string;\n  /**\n   * Maximum number of final matches returned by native APIs. Defaults to `5`.\n   */\n  maxResults?: number;\n  /**\n   * Prompt message shown inside the Android system dialog (ignored on iOS).\n   */\n  prompt?: string;\n  /**\n   * When `true`, Android shows the OS speech dialog instead of running inline recognition.\n   * Defaults to `false`.\n   */\n  popup?: boolean;\n  /**\n   * Emits partial transcription updates through the `partialResults` listener while audio is captured.\n   */\n  partialResults?: boolean;\n  /**\n   * Enables native punctuation handling where supported (iOS 16+).\n   */\n  addPunctuation?: boolean;\n  /**\n   * Words or phrases that should be recognized more accurately by native speech APIs.\n   *\n   * On iOS, these are passed to `SFSpeechRecognitionRequest.contextualStrings`\n   * when the plugin uses the legacy `SFSpeechRecognizer` path. That path is the\n   * default on all iOS versions, the fallback below iOS 26, and still available\n   * on iOS 26+ by leaving `useOnDeviceRecognition` disabled.\n   *\n   * Ignored by Android and by the iOS 26+ `SpeechAnalyzer` path.\n   */\n  contextualStrings?: string[];\n  /**\n   * Opt in to the platform's newer on-device recognition path when available.\n   *\n   * On iOS 26+, this uses Apple's `SpeechAnalyzer` / `SpeechTranscriber` pipeline.\n   * On recent Android versions, this uses the on-device `SpeechRecognizer` path.\n   *\n   * It is intentionally opt-in so existing apps keep the legacy flow unless they choose\n   * to roll out the new behavior.\n   * On iOS, leaving this disabled keeps `SFSpeechRecognizer` on every supported OS version.\n   * Enabling it on older iOS versions or unsupported locales falls back to `SFSpeechRecognizer`.\n   *\n   * Use {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable} before enabling it in production.\n   *\n   * Platform SDK docs:\n   * iOS: [Speech](https://developer.apple.com/documentation/speech),\n   * [SpeechAnalyzer](https://developer.apple.com/documentation/speech/speechanalyzer),\n   * [SpeechTranscriber](https://developer.apple.com/documentation/speech/speechtranscriber)\n   * Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)\n   *\n   * Defaults to `false`.\n   */\n  useOnDeviceRecognition?: boolean;\n  /**\n   * Allow a number of milliseconds of silence before splitting the recognition session into segments.\n   * Required to be greater than zero and currently supported on Android only.\n   */\n  allowForSilence?: number;\n  /**\n   * EXPERIMENTAL: Keep a PTT session alive across silence by restarting recognition while the button stays held.\n   *\n   * This restart behavior is implemented for Android inline recognition and iOS native recognition.\n   */\n  continuousPTT?: boolean;\n}\n\n/**\n * Raised whenever a partial transcription is produced.\n */\nexport interface SpeechRecognitionPartialResultEvent {\n  /**\n   * Current recognition matches when the native recognizer reports them.\n   *\n   * This can be omitted for forced or accumulated-only payloads.\n   */\n  matches?: string[];\n  /**\n   * Accumulated transcription from earlier continuous PTT cycles.\n   */\n  accumulated?: string;\n  /**\n   * Final accumulated text including the current result.\n   */\n  accumulatedText?: string;\n  /**\n   * `true` when the plugin is restarting recognition inside a continuous PTT session.\n   */\n  isRestarting?: boolean;\n  /**\n   * `true` when the payload was emitted by `forceStop()`.\n   */\n  forced?: boolean;\n}\n\n/**\n * Raised whenever a segmented result is produced (Android only).\n */\nexport interface SpeechRecognitionSegmentResultEvent {\n  matches: string[];\n}\n\n/**\n * Finite state values for the recognition session lifecycle.\n */\nexport type ListeningFiniteState = 'startingListening' | 'started' | 'stoppingListening' | 'stopped';\n\n/**\n * Why a listening state transition happened.\n */\nexport type ListeningReason = 'userStart' | 'userStop' | 'forceStop' | 'results' | 'silence' | 'error' | 'unknown';\n\n/**\n * Raised when the listening state changes.\n *\n * The original `status` field is preserved for backward compatibility and is present\n * on the binary `started` / `stopped` states.\n */\nexport interface SpeechRecognitionListeningEvent {\n  /**\n   * Finite state of the recognition session.\n   */\n  state?: ListeningFiniteState;\n  /**\n   * Unique identifier for the current listening session.\n   */\n  sessionId?: number;\n  /**\n   * Why this state transition occurred.\n   */\n  reason?: ListeningReason;\n  /**\n   * Error code when the transition is caused by an error.\n   */\n  errorCode?: string;\n  /**\n   * Backward-compatible binary state used by earlier releases.\n   */\n  status?: 'started' | 'stopped';\n}\n\n/**\n * Raised whenever native recognition reports an error.\n */\nexport interface SpeechRecognitionErrorEvent {\n  code: string;\n  message: string;\n  sessionId: number;\n}\n\n/**\n * Emitted after native resources have been torn down and the plugin is ready for another session.\n */\nexport interface SpeechRecognitionReadyEvent {\n  sessionId: number;\n}\n\nexport interface SpeechRecognitionAvailability {\n  available: boolean;\n}\n\nexport interface SpeechRecognitionMatches {\n  matches?: string[];\n}\n\nexport interface SpeechRecognitionLanguages {\n  languages: string[];\n}\n\nexport interface SpeechRecognitionListening {\n  listening: boolean;\n}\n\n/**\n * Options for {@link SpeechRecognitionPlugin.forceStop}.\n */\nexport interface ForceStopOptions {\n  /**\n   * Android only: timeout in milliseconds before forcing stop via destroy/recreate.\n   *\n   * On iOS, the current session is stopped immediately and this value is ignored.\n   *\n   * Defaults to `1500`.\n   */\n  timeout?: number;\n}\n\n/**\n * Result from {@link SpeechRecognitionPlugin.getLastPartialResult}.\n */\nexport interface LastPartialResult {\n  /**\n   * Whether a partial result is currently cached.\n   */\n  available: boolean;\n  /**\n   * The most recent transcript text known to the native recognizer.\n   */\n  text: string;\n  /**\n   * All current match alternatives when available.\n   */\n  matches?: string[];\n}\n\n/**\n * Options for {@link SpeechRecognitionPlugin.setPTTState}.\n */\nexport interface PTTStateOptions {\n  /**\n   * Whether the PTT button is currently held.\n   */\n  held: boolean;\n}\n\nexport interface SpeechRecognitionPlugin {\n  /**\n   * Checks whether the native speech recognition service is usable on the current device.\n   */\n  available(): Promise<SpeechRecognitionAvailability>;\n  /**\n   * Checks whether the platform's newer on-device recognition path is available for the selected locale.\n   *\n   * This is the capability check you should use before enabling `useOnDeviceRecognition`.\n   * A `true` result means the current device, OS version, and locale can use the newer\n   * on-device path for that platform.\n   *\n   * Returns `false` when the device only supports the legacy recognizer path.\n   *\n   * Platform SDK docs:\n   * iOS: [Speech](https://developer.apple.com/documentation/speech)\n   * Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)\n   */\n  isOnDeviceRecognitionAvailable(\n    options?: Pick<SpeechRecognitionStartOptions, 'language'>,\n  ): Promise<SpeechRecognitionAvailability>;\n  /**\n   * Begins capturing audio and transcribing speech.\n   *\n   * When `partialResults` is `true`, the returned promise resolves immediately and updates are\n   * streamed through the `partialResults` listener until the session ends.\n   *\n   * The default path keeps the legacy recognizer behavior for backward compatibility.\n   * Pass `useOnDeviceRecognition: true` only after checking\n   * {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable}.\n   */\n  start(options?: SpeechRecognitionStartOptions): Promise<SpeechRecognitionMatches>;\n  /**\n   * Stops listening and tears down native resources.\n   */\n  stop(): Promise<void>;\n  /**\n   * Force stops the current session.\n   *\n   * On Android, this first tries a normal stop and then falls back to destroy/recreate after `timeout`.\n   * On iOS, the current session is stopped immediately.\n   *\n   * If a partial transcript is cached, it is emitted through the `partialResults` listener with `forced: true`.\n   */\n  forceStop(options?: ForceStopOptions): Promise<void>;\n  /**\n   * Gets the last cached partial transcription result.\n   */\n  getLastPartialResult(): Promise<LastPartialResult>;\n  /**\n   * Updates the current push-to-talk button state.\n   *\n   * Use this together with `continuousPTT` or with a custom hold-to-talk flow.\n   */\n  setPTTState(options: PTTStateOptions): Promise<void>;\n  /**\n   * Gets the locales supported by the underlying recognizer.\n   *\n   * Android 13+ devices no longer expose this list; in that case `languages` is empty.\n   */\n  getSupportedLanguages(): Promise<SpeechRecognitionLanguages>;\n  /**\n   * Returns whether the plugin is actively listening for speech.\n   */\n  isListening(): Promise<SpeechRecognitionListening>;\n  /**\n   * Gets the current permission state.\n   */\n  checkPermissions(): Promise<SpeechRecognitionPermissionStatus>;\n  /**\n   * Requests the microphone + speech recognition permissions.\n   */\n  requestPermissions(): Promise<SpeechRecognitionPermissionStatus>;\n  /**\n   * Returns the native plugin version bundled with this package.\n   *\n   * Useful when reporting issues to confirm that native and JS versions match.\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n  /**\n   * Listen for segmented session completion events (Android only).\n   */\n  addListener(eventName: 'endOfSegmentedSession', listenerFunc: () => void): Promise<PluginListenerHandle>;\n  /**\n   * Listen for segmented recognition results (Android only).\n   */\n  addListener(\n    eventName: 'segmentResults',\n    listenerFunc: (event: SpeechRecognitionSegmentResultEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for partial transcription updates emitted while `partialResults` is enabled.\n   */\n  addListener(\n    eventName: 'partialResults',\n    listenerFunc: (event: SpeechRecognitionPartialResultEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for changes to the native listening state.\n   */\n  addListener(\n    eventName: 'listeningState',\n    listenerFunc: (event: SpeechRecognitionListeningEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for recognition errors.\n   */\n  addListener(\n    eventName: 'error',\n    listenerFunc: (event: SpeechRecognitionErrorEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for the recognizer becoming ready for another session.\n   */\n  addListener(\n    eventName: 'readyForNextSession',\n    listenerFunc: (event: SpeechRecognitionReadyEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Removes every registered listener.\n   */\n  removeAllListeners(): Promise<void>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Permission map returned by `checkPermissions` and `requestPermissions`.\n *\n * On Android the state maps to the `RECORD_AUDIO` permission.\n * On iOS it combines speech recognition plus microphone permission.\n */\nexport interface SpeechRecognitionPermissionStatus {\n  speechRecognition: PermissionState;\n}\n\n/**\n * Configure how the recognizer behaves when calling {@link SpeechRecognitionPlugin.start}.\n */\nexport interface SpeechRecognitionStartOptions {\n  /**\n   * Locale identifier such as `en-US`. When omitted the device language is used.\n   */\n  language?: string;\n  /**\n   * Maximum number of final matches returned by native APIs. Defaults to `5`.\n   */\n  maxResults?: number;\n  /**\n   * Prompt message shown inside the Android system dialog (ignored on iOS).\n   */\n  prompt?: string;\n  /**\n   * When `true`, Android shows the OS speech dialog instead of running inline recognition.\n   * Defaults to `false`.\n   */\n  popup?: boolean;\n  /**\n   * Emits partial transcription updates through the `partialResults` listener while audio is captured.\n   */\n  partialResults?: boolean;\n  /**\n   * Enables native punctuation handling where supported (iOS 16+).\n   */\n  addPunctuation?: boolean;\n  /**\n   * Words or phrases that should be recognized more accurately by native speech APIs.\n   *\n   * On iOS, these are passed to `SFSpeechRecognitionRequest.contextualStrings`\n   * when the plugin uses the legacy `SFSpeechRecognizer` path. That path is the\n   * default on all iOS versions, the fallback below iOS 26, and still available\n   * on iOS 26+ by leaving `useOnDeviceRecognition` disabled.\n   *\n   * Ignored by Android and by the iOS 26+ `SpeechAnalyzer` path.\n   */\n  contextualStrings?: string[];\n  /**\n   * Opt in to the platform's newer on-device recognition path when available.\n   *\n   * On iOS 26+, this uses Apple's `SpeechAnalyzer` / `SpeechTranscriber` pipeline.\n   * On recent Android versions, this uses the on-device `SpeechRecognizer` path.\n   *\n   * It is intentionally opt-in so existing apps keep the legacy flow unless they choose\n   * to roll out the new behavior.\n   * On iOS, leaving this disabled keeps `SFSpeechRecognizer` on every supported OS version.\n   * Enabling it on older iOS versions or unsupported locales falls back to `SFSpeechRecognizer`.\n   *\n   * Use {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable} before enabling it in production.\n   *\n   * Platform SDK docs:\n   * iOS: [Speech](https://developer.apple.com/documentation/speech),\n   * [SpeechAnalyzer](https://developer.apple.com/documentation/speech/speechanalyzer),\n   * [SpeechTranscriber](https://developer.apple.com/documentation/speech/speechtranscriber)\n   * Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)\n   *\n   * Defaults to `false`.\n   */\n  useOnDeviceRecognition?: boolean;\n  /**\n   * Allow a number of milliseconds of silence before splitting the recognition session into segments.\n   * Required to be greater than zero and currently supported on Android only.\n   */\n  allowForSilence?: number;\n  /**\n   * EXPERIMENTAL: Keep a PTT session alive across silence by restarting recognition while the button stays held.\n   *\n   * This restart behavior is implemented for Android inline recognition and iOS native recognition.\n   */\n  continuousPTT?: boolean;\n  /**\n   * Suppresses the Android system beep when inline recognition starts or restarts.\n   *\n   * Uses a best-effort combination of an undocumented recognizer intent extra and\n   * temporary notification/system stream volume muting. Some devices ignore the\n   * intent extra; the volume fallback is the portable path.\n   *\n   * Defaults to `true` when `continuousPTT` is enabled.\n   */\n  muteRecognizerBeep?: boolean;\n}\n\n/**\n * Raised whenever a partial transcription is produced.\n */\nexport interface SpeechRecognitionPartialResultEvent {\n  /**\n   * Current recognition matches when the native recognizer reports them.\n   *\n   * This can be omitted for forced or accumulated-only payloads.\n   */\n  matches?: string[];\n  /**\n   * Accumulated transcription from earlier continuous PTT cycles.\n   */\n  accumulated?: string;\n  /**\n   * Final accumulated text including the current result.\n   */\n  accumulatedText?: string;\n  /**\n   * `true` when the plugin is restarting recognition inside a continuous PTT session.\n   */\n  isRestarting?: boolean;\n  /**\n   * `true` when the payload was emitted by `forceStop()`.\n   */\n  forced?: boolean;\n}\n\n/**\n * Raised whenever a segmented result is produced (Android only).\n */\nexport interface SpeechRecognitionSegmentResultEvent {\n  matches: string[];\n}\n\n/**\n * Finite state values for the recognition session lifecycle.\n */\nexport type ListeningFiniteState = 'startingListening' | 'started' | 'stoppingListening' | 'stopped';\n\n/**\n * Why a listening state transition happened.\n */\nexport type ListeningReason = 'userStart' | 'userStop' | 'forceStop' | 'results' | 'silence' | 'error' | 'unknown';\n\n/**\n * Raised when the listening state changes.\n *\n * The original `status` field is preserved for backward compatibility and is present\n * on the binary `started` / `stopped` states.\n */\nexport interface SpeechRecognitionListeningEvent {\n  /**\n   * Finite state of the recognition session.\n   */\n  state?: ListeningFiniteState;\n  /**\n   * Unique identifier for the current listening session.\n   */\n  sessionId?: number;\n  /**\n   * Why this state transition occurred.\n   */\n  reason?: ListeningReason;\n  /**\n   * Error code when the transition is caused by an error.\n   */\n  errorCode?: string;\n  /**\n   * Backward-compatible binary state used by earlier releases.\n   */\n  status?: 'started' | 'stopped';\n}\n\n/**\n * Raised whenever native recognition reports an error.\n */\nexport interface SpeechRecognitionErrorEvent {\n  code: string;\n  message: string;\n  sessionId: number;\n}\n\n/**\n * Emitted after native resources have been torn down and the plugin is ready for another session.\n */\nexport interface SpeechRecognitionReadyEvent {\n  sessionId: number;\n}\n\nexport interface SpeechRecognitionAvailability {\n  available: boolean;\n}\n\nexport interface SpeechRecognitionMatches {\n  matches?: string[];\n}\n\nexport interface SpeechRecognitionLanguages {\n  languages: string[];\n}\n\nexport interface SpeechRecognitionListening {\n  listening: boolean;\n}\n\n/**\n * Options for {@link SpeechRecognitionPlugin.forceStop}.\n */\nexport interface ForceStopOptions {\n  /**\n   * Android only: timeout in milliseconds before forcing stop via destroy/recreate.\n   *\n   * On iOS, the current session is stopped immediately and this value is ignored.\n   *\n   * Defaults to `1500`.\n   */\n  timeout?: number;\n}\n\n/**\n * Result from {@link SpeechRecognitionPlugin.getLastPartialResult}.\n */\nexport interface LastPartialResult {\n  /**\n   * Whether a partial result is currently cached.\n   */\n  available: boolean;\n  /**\n   * The most recent transcript text known to the native recognizer.\n   */\n  text: string;\n  /**\n   * All current match alternatives when available.\n   */\n  matches?: string[];\n}\n\n/**\n * Options for {@link SpeechRecognitionPlugin.setPTTState}.\n */\nexport interface PTTStateOptions {\n  /**\n   * Whether the PTT button is currently held.\n   */\n  held: boolean;\n  /**\n   * When set, updates whether Android should suppress the recognizer start beep for the active session.\n   *\n   * Beep suppression is best-effort and device-specific; see {@link SpeechRecognitionStartOptions.muteRecognizerBeep}.\n   */\n  mute?: boolean;\n}\n\nexport interface SpeechRecognitionPlugin {\n  /**\n   * Checks whether the native speech recognition service is usable on the current device.\n   */\n  available(): Promise<SpeechRecognitionAvailability>;\n  /**\n   * Checks whether the platform's newer on-device recognition path is available for the selected locale.\n   *\n   * This is the capability check you should use before enabling `useOnDeviceRecognition`.\n   * A `true` result means the current device, OS version, and locale can use the newer\n   * on-device path for that platform.\n   *\n   * Returns `false` when the device only supports the legacy recognizer path.\n   *\n   * Platform SDK docs:\n   * iOS: [Speech](https://developer.apple.com/documentation/speech)\n   * Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)\n   */\n  isOnDeviceRecognitionAvailable(\n    options?: Pick<SpeechRecognitionStartOptions, 'language'>,\n  ): Promise<SpeechRecognitionAvailability>;\n  /**\n   * Begins capturing audio and transcribing speech.\n   *\n   * When `partialResults` is `true`, the returned promise resolves immediately and updates are\n   * streamed through the `partialResults` listener until the session ends.\n   *\n   * The default path keeps the legacy recognizer behavior for backward compatibility.\n   * Pass `useOnDeviceRecognition: true` only after checking\n   * {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable}.\n   */\n  start(options?: SpeechRecognitionStartOptions): Promise<SpeechRecognitionMatches>;\n  /**\n   * Stops listening and tears down native resources.\n   */\n  stop(): Promise<void>;\n  /**\n   * Force stops the current session.\n   *\n   * On Android, this first tries a normal stop and then falls back to destroy/recreate after `timeout`.\n   * On iOS, the current session is stopped immediately.\n   *\n   * If a partial transcript is cached, it is emitted through the `partialResults` listener with `forced: true`.\n   */\n  forceStop(options?: ForceStopOptions): Promise<void>;\n  /**\n   * Gets the last cached partial transcription result.\n   */\n  getLastPartialResult(): Promise<LastPartialResult>;\n  /**\n   * Updates the current push-to-talk button state.\n   *\n   * Use this together with `continuousPTT` or with a custom hold-to-talk flow.\n   */\n  setPTTState(options: PTTStateOptions): Promise<void>;\n  /**\n   * Gets the locales supported by the underlying recognizer.\n   *\n   * Android 13+ devices no longer expose this list; in that case `languages` is empty.\n   */\n  getSupportedLanguages(): Promise<SpeechRecognitionLanguages>;\n  /**\n   * Returns whether the plugin is actively listening for speech.\n   */\n  isListening(): Promise<SpeechRecognitionListening>;\n  /**\n   * Gets the current permission state.\n   */\n  checkPermissions(): Promise<SpeechRecognitionPermissionStatus>;\n  /**\n   * Requests the microphone + speech recognition permissions.\n   */\n  requestPermissions(): Promise<SpeechRecognitionPermissionStatus>;\n  /**\n   * Returns the native plugin version bundled with this package.\n   *\n   * Useful when reporting issues to confirm that native and JS versions match.\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n  /**\n   * Listen for segmented session completion events (Android only).\n   */\n  addListener(eventName: 'endOfSegmentedSession', listenerFunc: () => void): Promise<PluginListenerHandle>;\n  /**\n   * Listen for segmented recognition results (Android only).\n   */\n  addListener(\n    eventName: 'segmentResults',\n    listenerFunc: (event: SpeechRecognitionSegmentResultEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for partial transcription updates emitted while `partialResults` is enabled.\n   */\n  addListener(\n    eventName: 'partialResults',\n    listenerFunc: (event: SpeechRecognitionPartialResultEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for changes to the native listening state.\n   */\n  addListener(\n    eventName: 'listeningState',\n    listenerFunc: (event: SpeechRecognitionListeningEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for recognition errors.\n   */\n  addListener(\n    eventName: 'error',\n    listenerFunc: (event: SpeechRecognitionErrorEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Listen for the recognizer becoming ready for another session.\n   */\n  addListener(\n    eventName: 'readyForNextSession',\n    listenerFunc: (event: SpeechRecognitionReadyEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Removes every registered listener.\n   */\n  removeAllListeners(): Promise<void>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-speech-recognition",
-  "version": "8.1.7",
+  "version": "8.1.8",
   "description": "Capacitor plugin for comprehensive on-device speech recognition with live partial results.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",