@capgo/capacitor-speech-recognition

Overview

Capacitor plugin for comprehensive on-device speech recognition with live partial results.

Core Capabilities

• available - Checks whether the native speech recognition service is usable on the current device.
• isOnDeviceRecognitionAvailable - Checks whether the platform’s newer on-device recognition path is available for the selected locale.
• start - Begins capturing audio and transcribing speech.
• stop - Stops listening and tears down native resources.

Public API

Method	Description
available	Checks whether the native speech recognition service is usable on the current device.
isOnDeviceRecognitionAvailable	Checks whether the platform’s newer on-device recognition path is available for the selected locale.
start	Begins capturing audio and transcribing speech.
stop	Stops listening and tears down native resources.
forceStop	Force stops the current session.
getLastPartialResult	Gets the last cached partial transcription result.
setPTTState	Updates the current push-to-talk button state.
getSupportedLanguages	Gets the locales supported by the underlying recognizer.
isListening	Returns whether the plugin is actively listening for speech.
checkPermissions	Gets the current permission state.
requestPermissions	Requests the microphone + speech recognition permissions.
getPluginVersion	Returns the native plugin version bundled with this package.
addListener	Listen for segmented session completion events (Android only).
addListener	Listen for segmented recognition results (Android only).
addListener	Listen for partial transcription updates emitted while partialResults is enabled.
addListener	Listen for changes to the native listening state.
addListener	Listen for recognition errors.
addListener	Listen for the recognizer becoming ready for another session.
removeAllListeners	Removes every registered listener.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-speech-recognition.

Keep going from @capgo/capacitor-speech-recognition

If you are using @capgo/capacitor-speech-recognition to plan dashboard and API operations, connect it with Using @capgo/capacitor-speech-recognition for the native capability in Using @capgo/capacitor-speech-recognition, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.