diff --git a/packages/speech-recognition/README.md b/packages/speech-recognition/README.md index 6aa940dc..cc67614e 100644 --- a/packages/speech-recognition/README.md +++ b/packages/speech-recognition/README.md @@ -4,12 +4,13 @@ Capacitor plugin to transcribe speech into text. ## Features -- 🔋 Supports Android and iOS. -- ⚡️ Capacitor 6 support. +- 🖥️ **Cross-platform**: Supports Android, iOS and Web. - 🌐 **Multiple languages**: Supports many different languages. - 🛠 **Permissions**: Check and request permissions for recording audio. - 🎧 **Listening**: Check if the speech recognizer is available and currently listening. - 🎙 **Events**: Listen for events like `beginningOfSpeech`, `endOfSpeech`, `error`, `partialResults`, `readyForSpeech`, and `results`. +- 🔇 **Silence Detection**: Automatically detects silence to stop the recording. +- 🔁 **Up-to-date**: Always supports the latest Capacitor version. ## Installation @@ -173,8 +174,6 @@ isAvailable() => Promise Check if the speech recognizer is available on the device. -Only available on Android and iOS. - **Returns:** Promise<IsAvailableResult> **Since:** 6.0.0 @@ -190,8 +189,6 @@ isListening() => Promise Check if the speech recognizer is currently listening. -Only available on Android and iOS. - **Returns:** Promise<IsListeningResult> **Since:** 6.0.0 @@ -207,8 +204,6 @@ startListening(options?: StartListeningOptions | undefined) => Promise Start listening for speech. -Only available on Android and iOS. - | Param | Type | | ------------- | ----------------------------------------------------------------------- | | **`options`** | StartListeningOptions | @@ -226,8 +221,6 @@ stopListening() => Promise Stop listening for speech. -Only available on Android and iOS. - **Since:** 6.0.0 -------------------- @@ -241,8 +234,6 @@ checkPermissions() => Promise Check permissions for the plugin. -Only available on Android and iOS. - **Returns:** Promise<PermissionStatus> **Since:** 6.0.0 @@ -258,8 +249,6 @@ requestPermissions() => Promise Request permissions for the plugin. -Only available on Android and iOS. - **Returns:** Promise<PermissionStatus> **Since:** 6.0.0 @@ -275,7 +264,7 @@ addListener(eventName: 'beginningOfSpeech', listenerFunc: () => void) => Promise Called when the user has started to speak. -Only available on Android. +Only available on Android and Web. | Param | Type | | ------------------ | -------------------------------- | @@ -297,7 +286,7 @@ addListener(eventName: 'endOfSpeech', listenerFunc: () => void) => Promise void) => Pr Called when an error occurs. -Only available on Android and iOS. - | Param | Type | | ------------------ | --------------------------------------------------------------------- | | **`eventName`** | 'error' | @@ -341,8 +328,6 @@ addListener(eventName: 'listeningState', listenerFunc: (event: ListeningStateEve Called when the listening state changes. -Only available on Android and iOS. - | Param | Type | | ------------------ | --------------------------------------------------------------------------------------- | | **`eventName`** | 'listeningState' | @@ -363,8 +348,6 @@ addListener(eventName: 'partialResults', listenerFunc: (event: PartialResultsEve Called when a partial result is available. -Only available on Android and iOS. - | Param | Type | | ------------------ | --------------------------------------------------------------------------------------- | | **`eventName`** | 'partialResults' | @@ -385,8 +368,6 @@ addListener(eventName: 'readyForSpeech', listenerFunc: () => void) => Promise'readyForSpeech' | @@ -407,8 +388,6 @@ addListener(eventName: 'results', listenerFunc: (event: ResultsEvent) => void) = Called when the final results are available. -Only available on Android and iOS. - | Param | Type | | ------------------ | ------------------------------------------------------------------------- | | **`eventName`** | 'results' |