Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-speech-recognition
Tutorial
by github.com/Cap-go

Speech Recognition

Natural, low-latency speech recognition with streaming partial results and cross-platform parity

Downloads/week

60.2k

GitHub Stars

15

Guide

Tutorial on Speech Recognition

Using @capgo/capacitor-speech-recognition

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

Install

bun add @capgo/capacitor-speech-recognition
bunx cap sync

What This Plugin Exposes

  • 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.

Example Usage

available

Checks whether the native speech recognition service is usable on the current device.

import { SpeechRecognition } from '@capgo/capacitor-speech-recognition';

await SpeechRecognition.available();

isOnDeviceRecognitionAvailable

Checks whether the platform's newer on-device recognition path is available for the selected locale.

import { SpeechRecognition } from '@capgo/capacitor-speech-recognition';

await SpeechRecognition.isOnDeviceRecognitionAvailable();

start

Begins capturing audio and transcribing speech.

import { SpeechRecognition } from '@capgo/capacitor-speech-recognition';

await SpeechRecognition.start();

stop

Stops listening and tears down native resources.

import { SpeechRecognition } from '@capgo/capacitor-speech-recognition';

await SpeechRecognition.stop();

Full Reference

Keep going from Using @capgo/capacitor-speech-recognition

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