@capgo/capacitor-speech-recognition 8.3.1 → 8.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,21 +1,37 @@
1
1
  # @capgo/capacitor-speech-recognition
2
- <a href="https://capgo.app/"><img src="https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-speech-recognition" alt="Capgo - Instant updates for Capacitor" /></a>
2
+
3
+ Turn speech into text in your Capacitor app with low latency, live partial results and the native recognizers on iOS and Android.
4
+
5
+ <a href="https://capgo.app/?ref=plugin_speech_recognition"><img src="https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-speech-recognition" alt="Capgo - Instant updates for Capacitor" /></a>
3
6
 
4
7
  <div align="center">
5
- <h2><a href="https://capgo.app/?ref=plugin_speech_recognition"> ➡️ Get Instant updates for your App with Capgo</a></h2>
6
- <h2><a href="https://capgo.app/consulting/?ref=plugin_speech_recognition"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
8
+ <p><b>Capgo</b>: open-source live updates for Ionic and Capacitor apps. Ship OTA fixes and features instantly, without waiting for app store review.</p>
9
+ <h2><a href="https://capgo.app/register/?ref=plugin_speech_recognition">➡️ Get started for free</a></h2>
10
+ <p>14-day unlimited free trial. No credit card required</p>
11
+ <p><a href="https://capgo.app/consulting/?ref=plugin_speech_recognition">Missing a feature? We'll build the plugin for you 💪</a></p>
7
12
  </div>
8
13
 
9
- Natural, low-latency speech recognition for Capacitor apps with parity across iOS and Android, streaming partial results, and permission helpers baked in.
14
+ <p align="center">
15
+ <img src="https://raw.githubusercontent.com/Cap-go/capacitor-speech-recognition/main/assets/github-social-preview.png" alt="@capgo/capacitor-speech-recognition for Capacitor apps" width="300" />
16
+ </p>
17
+
18
+ ## Key features
19
+
20
+ - **Live transcription**: `start()` streams `partialResults` while the user speaks, `stop()` and `forceStop()` end it.
21
+ - **Languages**: `getSupportedLanguages()` and `isOnDeviceRecognitionAvailable()` for offline recognition.
22
+ - **Accuracy options**: punctuation on iOS 16 and later and contextual strings for domain words.
23
+ - **Push to talk**: `setPTTState()` keeps a session going while the button is held.
24
+ - **Events and permissions**: `listeningState`, `audioLevel` and `error` events, plus microphone and speech permission helpers.
25
+ - **Platforms**: iOS and Android. iOS uses the Speech framework, Android uses `SpeechRecognizer`. Segmented results are Android only. Not available on web.
10
26
 
11
27
  ## Why this plugin?
12
28
 
13
29
  This package starts from the excellent [`capacitor-community/speech-recognition`](https://github.com/capacitor-community/speech-recognition) plugin, but folds in the most requested pull requests from that repo (punctuation support, segmented sessions, crash fixes) and keeps them maintained under the Capgo umbrella. You get the familiar API plus:
14
30
 
15
- - ✅ **Merged community PRs** – punctuation toggles on iOS (PR #74), segmented results & silence handling on Android (PR #104), and the `recognitionRequest` safety fix (PR #105) ship out-of-the-box.
16
- - 🚀 **New Capgo features** – configurable silence windows, streaming segment listeners, consistent permission helpers, and a refreshed example app.
17
- - 🛠️ **Active maintenance** – same conventions as all Capgo plugins (SPM, Podspec, workflows, example app) so it tracks Capacitor major versions without bit-rot.
18
- - 📦 **Drop-in migration** – TypeScript definitions remain compatible with the community plugin while exposing the extra options (`addPunctuation`, `allowForSilence`, `segmentResults`, etc.).
31
+ - ✅ **Merged community PRs**, punctuation toggles on iOS (PR #74), segmented results & silence handling on Android (PR #104), and the `recognitionRequest` safety fix (PR #105) ship out-of-the-box.
32
+ - 🚀 **New Capgo features**, configurable silence windows, streaming segment listeners, consistent permission helpers, and a refreshed example app.
33
+ - 🛠️ **Active maintenance**, same conventions as all Capgo plugins (SPM, Podspec, workflows, example app) so it tracks Capacitor major versions without bit-rot.
34
+ - 📦 **Drop-in migration**, TypeScript definitions remain compatible with the community plugin while exposing the extra options (`addPunctuation`, `allowForSilence`, `segmentResults`, etc.).
19
35
 
20
36
  ## Documentation
21
37
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@capgo/capacitor-speech-recognition",
3
- "version": "8.3.1",
3
+ "version": "8.3.3",
4
4
  "description": "Capacitor plugin for comprehensive on-device speech recognition with live partial results.",
5
5
  "main": "dist/plugin.cjs.js",
6
6
  "module": "dist/esm/index.js",