Empezar

Instalar

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

Importar

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

API Resumen

available

Verifica si el servicio de reconocimiento de voz nativo está disponible en el dispositivo actual.

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

await SpeechRecognition.available();

isOnDeviceRecognitionAvailable

Verifica si el camino de reconocimiento en dispositivo más reciente del plataforma está disponible para el idioma seleccionado.

Esta es la comprobación de capacidad que debes usar antes de habilitar useOnDeviceRecognitionUn resultado significa que el dispositivo, la versión del sistema operativo y el idioma pueden usar el camino más reciente para esa plataforma. true Devuelve

Cuando el dispositivo solo admite el camino del reconocedor de legado. false Documentación de la plataforma __CAPGO_KEEP_0__:

Platform SDK docs: iOS: Habla Android: Reconocedor de habla

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

await SpeechRecognition.isOnDeviceRecognitionAvailable();

start

Comienza a capturar audio y transcribe la habla.

Cuando partialResults es true, la promesa devuelta se resuelve de inmediato y se envían actualizaciones a través del partialResults listener hasta que la sesión termina.

El camino por defecto mantiene el comportamiento del reconocedor legado para compatibilidad hacia atrás. Debes useOnDeviceRecognition: true pasar

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

await SpeechRecognition.start();

stop

Detiene la escucha y desmonta los recursos nativos.

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

await SpeechRecognition.stop();

forceStop

Detiene forzadamente la sesión actual.

En Android, esto intenta detener normalmente primero y luego cae en destroy/recreate después timeoutEn iOS, la sesión actual se detiene inmediatamente.

Si se ha almacenado un resultado de transcripción parcial, se emite a través del partialResults escuchador con forced: true.

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

await SpeechRecognition.forceStop();

getLastPartialResult

Obtiene el último resultado de transcripción parcial almacenado.

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

await SpeechRecognition.getLastPartialResult();

setPTTState

Actualiza el estado actual del botón de habla a demanda.

Use esto junto con continuousPTT o con un flujo de habla a demanda personalizado.

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

await SpeechRecognition.setPTTState({} as PTTStateOptions);

getSupportedLanguages

Obtiene los idiomas locales soportados por el reconocedor subyacente.

Los dispositivos Android 13+ ya no exponen esta lista; en ese caso languages está vacío.

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

await SpeechRecognition.getSupportedLanguages();

isListening

Devuelve si el plugin está escuchando activamente la voz.

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

await SpeechRecognition.isListening();

checkPermissions

Obtiene el estado de permisos actual.

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

await SpeechRecognition.checkPermissions();

requestPermissions

Solicita los permisos de micrófono + reconocimiento de voz.

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

await SpeechRecognition.requestPermissions();

Referencia de tipos

SpeechRecognitionAvailability

export interface SpeechRecognitionAvailability {
  available: boolean;
}

SpeechRecognitionStartOptions

Configure cómo el reconocedor se comporta cuando se llama a .

export interface SpeechRecognitionStartOptions {
  /**
   * Locale identifier such as `en-US`. When omitted the device language is used.
   */
  language?: string;
  /**
   * Maximum number of final matches returned by native APIs. Defaults to `5`.
   */
  maxResults?: number;
  /**
   * Prompt message shown inside the Android system dialog (ignored on iOS).
   */
  prompt?: string;
  /**
   * When `true`, Android shows the OS speech dialog instead of running inline recognition.
   * Defaults to `false`.
   */
  popup?: boolean;
  /**
   * Emits partial transcription updates through the `partialResults` listener while audio is captured.
   */
  partialResults?: boolean;
  /**
   * Enables native punctuation handling where supported (iOS 16+).
   */
  addPunctuation?: boolean;
  /**
   * Opt in to the platform's newer on-device recognition path when available.
   *
   * On iOS 26+, this uses Apple's `SpeechAnalyzer` / `SpeechTranscriber` pipeline.
   * On recent Android versions, this uses the on-device `SpeechRecognizer` path.
   *
   * It is intentionally opt-in so existing apps keep the legacy flow unless they choose
   * to roll out the new behavior.
   *
   * Use {@link SpeechRecognitionPlugin.isOnDeviceRecognitionAvailable} before enabling it in production.
   *
   * Platform SDK docs:
   * iOS: [Speech](https://developer.apple.com/documentation/speech),
   * [SpeechAnalyzer](https://developer.apple.com/documentation/speech/speechanalyzer),
   * [SpeechTranscriber](https://developer.apple.com/documentation/speech/speechtranscriber)
   * Android: [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)
   *
   * Defaults to `false`.
   */
  useOnDeviceRecognition?: boolean;
  /**
   * Allow a number of milliseconds of silence before splitting the recognition session into segments.
   * Required to be greater than zero and currently supported on Android only.
   */
  allowForSilence?: number;
  /**
   * EXPERIMENTAL: Keep a PTT session alive across silence by restarting recognition while the button stays held.
   *
   * This restart behavior is implemented for Android inline recognition and iOS native recognition.
   */
  continuousPTT?: boolean;
}

SpeechRecognitionMatches

export interface SpeechRecognitionMatches {
  matches?: string[];
}

ForceStopOptions

Opciones para .

export interface ForceStopOptions {
  /**
   * Android only: timeout in milliseconds before forcing stop via destroy/recreate.
   *
   * On iOS, the current session is stopped immediately and this value is ignored.
   *
   * Defaults to `1500`.
   */
  timeout?: number;
}

LastPartialResult

Resultado de .

export interface LastPartialResult {
  /**
   * Whether a partial result is currently cached.
   */
  available: boolean;
  /**
   * The most recent transcript text known to the native recognizer.
   */
  text: string;
  /**
   * All current match alternatives when available.
   */
  matches?: string[];
}

PTTStateOptions

Opciones para .

export interface PTTStateOptions {
  /**
   * Whether the PTT button is currently held.
   */
  held: boolean;
}

SpeechRecognitionLanguages

export interface SpeechRecognitionLanguages {
  languages: string[];
}

SpeechRecognitionListening

export interface SpeechRecognitionListening {
  listening: boolean;
}

SpeechRecognitionPermissionStatus

Mapa de permisos devuelto por checkPermissions y requestPermissions.

export interface SpeechRecognitionPermissionStatus {
  speechRecognition: PermissionState;
}

SpeechRecognitionSegmentResultEvent

Se levanta cada vez que se produce un resultado segmentado (solo para Android).

export interface SpeechRecognitionSegmentResultEvent {
  matches: string[];
}

SpeechRecognitionPartialResultEvent

Se levanta cada vez que se produce una transcripción parcial.

export interface SpeechRecognitionPartialResultEvent {
  /**
   * Current recognition matches when the native recognizer reports them.
   *
   * This can be omitted for forced or accumulated-only payloads.
   */
  matches?: string[];
  /**
   * Accumulated transcription from earlier continuous PTT cycles.
   */
  accumulated?: string;
  /**
   * Final accumulated text including the current result.
   */
  accumulatedText?: string;
  /**
   * `true` when the plugin is restarting recognition inside a continuous PTT session.
   */
  isRestarting?: boolean;
  /**
   * `true` when the payload was emitted by `forceStop()`.
   */
  forced?: boolean;
}

SpeechRecognitionListeningEvent

Se levanta cuando cambia el estado de escucha.

export interface SpeechRecognitionListeningEvent {
  /**
   * Finite state of the recognition session.
   */
  state?: ListeningFiniteState;
  /**
   * Unique identifier for the current listening session.
   */
  sessionId?: number;
  /**
   * Why this state transition occurred.
   */
  reason?: ListeningReason;
  /**
   * Error code when the transition is caused by an error.
   */
  errorCode?: string;
  /**
   * Backward-compatible binary state used by earlier releases.
   */
  status?: 'started' | 'stopped';
}

Fuente de Verdad

Esta página se genera a partir del plugin’s. Re-ejecutar la sincronización cuando el público __CAPGO_KEEP_0__ cambie en la fuente. src/definitions.ts. Re-run the sync when the public API changes upstream.