@capgo/capacitor-speech-recognition 8.0.9 → 8.1.0

package/dist/docs.json

@@ -17,6 +17,26 @@
         ],
         "slug": "available"
       },
+      {
+        "name": "isOnDeviceRecognitionAvailable",
+        "signature": "(options?: Pick<SpeechRecognitionStartOptions, \"language\"> | undefined) => Promise<SpeechRecognitionAvailability>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "Pick<SpeechRecognitionStartOptions, 'language'> | undefined"
+          }
+        ],
+        "returns": "Promise<SpeechRecognitionAvailability>",
+        "tags": [],
+        "docs": "Checks whether the platform's newer on-device recognition path is available for the selected locale.\n\nThis is the capability check you should use before enabling `useOnDeviceRecognition`.\nA `true` result means the current device, OS version, and locale can use the newer\non-device path for that platform.\n\nReturns `false` when the device only supports the legacy recognizer path.\n\nPlatform SDK docs:\niOS: [Speech](https://developer.apple.com/documentation/speech)\nAndroid: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)",
+        "complexTypes": [
+          "SpeechRecognitionAvailability",
+          "Pick",
+          "SpeechRecognitionStartOptions"
+        ],
+        "slug": "isondevicerecognitionavailable"
+      },
       {
         "name": "start",
         "signature": "(options?: SpeechRecognitionStartOptions | undefined) => Promise<SpeechRecognitionMatches>",
@@ -29,7 +49,7 @@
         ],
         "returns": "Promise<SpeechRecognitionMatches>",
         "tags": [],
-        "docs": "Begins capturing audio and transcribing speech.\n\nWhen `partialResults` is `true`, the returned promise resolves immediately and updates are\nstreamed through the `partialResults` listener until {@link stop} is called.",
+        "docs": "Begins capturing audio and transcribing speech.\n\nWhen `partialResults` is `true`, the returned promise resolves immediately and updates are\nstreamed through the `partialResults` listener until the session ends.\n\nThe default path keeps the legacy recognizer behavior for backward compatibility.\nPass `useOnDeviceRecognition: true` only after checking\n{@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable}.",
         "complexTypes": [
           "SpeechRecognitionMatches",
           "SpeechRecognitionStartOptions"
@@ -46,6 +66,54 @@
         "complexTypes": [],
         "slug": "stop"
       },
+      {
+        "name": "forceStop",
+        "signature": "(options?: ForceStopOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ForceStopOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Force stops the current session.\n\nOn Android, this first tries a normal stop and then falls back to destroy/recreate after `timeout`.\nOn iOS, the current session is stopped immediately.\n\nIf a partial transcript is cached, it is emitted through the `partialResults` listener with `forced: true`.",
+        "complexTypes": [
+          "ForceStopOptions"
+        ],
+        "slug": "forcestop"
+      },
+      {
+        "name": "getLastPartialResult",
+        "signature": "() => Promise<LastPartialResult>",
+        "parameters": [],
+        "returns": "Promise<LastPartialResult>",
+        "tags": [],
+        "docs": "Gets the last cached partial transcription result.",
+        "complexTypes": [
+          "LastPartialResult"
+        ],
+        "slug": "getlastpartialresult"
+      },
+      {
+        "name": "setPTTState",
+        "signature": "(options: PTTStateOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PTTStateOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Updates the current push-to-talk button state.\n\nUse this together with `continuousPTT` or with a custom hold-to-talk flow.",
+        "complexTypes": [
+          "PTTStateOptions"
+        ],
+        "slug": "setpttstate"
+      },
       {
         "name": "getSupportedLanguages",
         "signature": "() => Promise<SpeechRecognitionLanguages>",
@@ -199,6 +267,54 @@
         ],
         "slug": "addlistenerlisteningstate-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'error', listenerFunc: (event: SpeechRecognitionErrorEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'error'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: SpeechRecognitionErrorEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for recognition errors.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SpeechRecognitionErrorEvent"
+        ],
+        "slug": "addlistenererror-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readyForNextSession', listenerFunc: (event: SpeechRecognitionReadyEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readyForNextSession'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: SpeechRecognitionReadyEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for the recognizer becoming ready for another session.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SpeechRecognitionReadyEvent"
+        ],
+        "slug": "addlistenerreadyfornextsession-"
+      },
       {
         "name": "removeAllListeners",
         "signature": "() => Promise<void>",
@@ -229,22 +345,6 @@
         }
       ]
     },
-    {
-      "name": "SpeechRecognitionMatches",
-      "slug": "speechrecognitionmatches",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "matches",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string[] | undefined"
-        }
-      ]
-    },
     {
       "name": "SpeechRecognitionStartOptions",
       "slug": "speechrecognitionstartoptions",
@@ -294,12 +394,104 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "useOnDeviceRecognition",
+          "tags": [],
+          "docs": "Opt in to the platform's newer on-device recognition path when available.\n\nOn iOS 26+, this uses Apple's `SpeechAnalyzer` / `SpeechTranscriber` pipeline.\nOn recent Android versions, this uses the on-device `SpeechRecognizer` path.\n\nIt is intentionally opt-in so existing apps keep the legacy flow unless they choose\nto roll out the new behavior.\n\nUse {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable} before enabling it in production.\n\nPlatform SDK docs:\niOS: [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)\nAndroid: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)\n\nDefaults to `false`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "allowForSilence",
           "tags": [],
           "docs": "Allow a number of milliseconds of silence before splitting the recognition session into segments.\nRequired to be greater than zero and currently supported on Android only.",
           "complexTypes": [],
           "type": "number | undefined"
+        },
+        {
+          "name": "continuousPTT",
+          "tags": [],
+          "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": "SpeechRecognitionMatches",
+      "slug": "speechrecognitionmatches",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "matches",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ForceStopOptions",
+      "slug": "forcestopoptions",
+      "docs": "Options for {@link SpeechRecognitionPlugin.forceStop}.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "timeout",
+          "tags": [],
+          "docs": "Android only: timeout in milliseconds before forcing stop via destroy/recreate.\n\nOn iOS, the current session is stopped immediately and this value is ignored.\n\nDefaults to `1500`.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LastPartialResult",
+      "slug": "lastpartialresult",
+      "docs": "Result from {@link SpeechRecognitionPlugin.getLastPartialResult}.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [],
+          "docs": "Whether a partial result is currently cached.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "text",
+          "tags": [],
+          "docs": "The most recent transcript text known to the native recognizer.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "matches",
+          "tags": [],
+          "docs": "All current match alternatives when available.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PTTStateOptions",
+      "slug": "pttstateoptions",
+      "docs": "Options for {@link SpeechRecognitionPlugin.setPTTState}.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "held",
+          "tags": [],
+          "docs": "Whether the PTT button is currently held.",
+          "complexTypes": [],
+          "type": "boolean"
         }
       ]
     },
@@ -395,31 +587,152 @@
         {
           "name": "matches",
           "tags": [],
-          "docs": "",
+          "docs": "Current recognition matches when the native recognizer reports them.\n\nThis can be omitted for forced or accumulated-only payloads.",
           "complexTypes": [],
-          "type": "string[]"
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "accumulated",
+          "tags": [],
+          "docs": "Accumulated transcription from earlier continuous PTT cycles.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "accumulatedText",
+          "tags": [],
+          "docs": "Final accumulated text including the current result.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "isRestarting",
+          "tags": [],
+          "docs": "`true` when the plugin is restarting recognition inside a continuous PTT session.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "forced",
+          "tags": [],
+          "docs": "`true` when the payload was emitted by `forceStop()`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
     {
       "name": "SpeechRecognitionListeningEvent",
       "slug": "speechrecognitionlisteningevent",
-      "docs": "Raised when the listening state changes.",
+      "docs": "Raised when the listening state changes.\n\nThe original `status` field is preserved for backward compatibility and is present\non the binary `started` / `stopped` states.",
       "tags": [],
       "methods": [],
       "properties": [
+        {
+          "name": "state",
+          "tags": [],
+          "docs": "Finite state of the recognition session.",
+          "complexTypes": [
+            "ListeningFiniteState"
+          ],
+          "type": "ListeningFiniteState"
+        },
+        {
+          "name": "sessionId",
+          "tags": [],
+          "docs": "Unique identifier for the current listening session.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "reason",
+          "tags": [],
+          "docs": "Why this state transition occurred.",
+          "complexTypes": [
+            "ListeningReason"
+          ],
+          "type": "ListeningReason"
+        },
+        {
+          "name": "errorCode",
+          "tags": [],
+          "docs": "Error code when the transition is caused by an error.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
         {
           "name": "status",
           "tags": [],
+          "docs": "Backward-compatible binary state used by earlier releases.",
+          "complexTypes": [],
+          "type": "'started' | 'stopped' | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SpeechRecognitionErrorEvent",
+      "slug": "speechrecognitionerrorevent",
+      "docs": "Raised whenever native recognition reports an error.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "sessionId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "SpeechRecognitionReadyEvent",
+      "slug": "speechrecognitionreadyevent",
+      "docs": "Emitted after native resources have been torn down and the plugin is ready for another session.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "sessionId",
+          "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "'started' | 'stopped'"
+          "type": "number"
         }
       ]
     }
   ],
   "enums": [],
   "typeAliases": [
+    {
+      "name": "Pick",
+      "slug": "pick",
+      "docs": "From T, pick a set of properties whose keys are in the union K",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T[P];\r\n}",
+          "complexTypes": [
+            "K",
+            "T",
+            "P"
+          ]
+        }
+      ]
+    },
     {
       "name": "PermissionState",
       "slug": "permissionstate",
@@ -442,6 +755,64 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "ListeningFiniteState",
+      "slug": "listeningfinitestate",
+      "docs": "Finite state values for the recognition session lifecycle.",
+      "types": [
+        {
+          "text": "'startingListening'",
+          "complexTypes": []
+        },
+        {
+          "text": "'started'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stoppingListening'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stopped'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "ListeningReason",
+      "slug": "listeningreason",
+      "docs": "Why a listening state transition happened.",
+      "types": [
+        {
+          "text": "'userStart'",
+          "complexTypes": []
+        },
+        {
+          "text": "'userStop'",
+          "complexTypes": []
+        },
+        {
+          "text": "'forceStop'",
+          "complexTypes": []
+        },
+        {
+          "text": "'results'",
+          "complexTypes": []
+        },
+        {
+          "text": "'silence'",
+          "complexTypes": []
+        },
+        {
+          "text": "'error'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []