开始入门

安装

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

导入

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

API 概述

available

检查当前设备上的本机语音识别服务是否可用。

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

await SpeechRecognition.available();

isOnDeviceRecognitionAvailable

检查所选语言环境下平台的新设备识别路径是否可用。

这是您应该在启用之前使用的能力检查。 useOnDeviceRecognition。 A true 结果表示当前设备、操作系统版本和语言环境可以使用该平台的新设备路径。

返回 false 当设备仅支持遗留识别器路径时返回。

Platform SDK 文档： iOS： 安卓： 语音识别器

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

await SpeechRecognition.isOnDeviceRecognitionAvailable();

start

当

是 partialResults ,返回的 promise 立即解析并通过 true监听器更新 partialResults 直到会话结束

默认路径保留了遗留的识别器行为以保持向后兼容性。请 useOnDeviceRecognition: true 仅在检查后

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

await SpeechRecognition.start();

stop

停止监听并释放本机资源。

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

await SpeechRecognition.stop();

forceStop

强制停止当前会话。

在 Android 上，这首先尝试正常停止，然后再 fallback 到销毁/重新创建。 timeout在 iOS 上，当前会话立即停止。

如果有部分转录缓存，会通过 partialResults listener forced: true.

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

await SpeechRecognition.forceStop();

getLastPartialResult

Section titled “获取最后的部分结果”

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

await SpeechRecognition.getLastPartialResult();

setPTTState

更新当前的按压说话按钮状态。

与此同时使用 continuousPTT 或使用自定义按住说话流程。

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

await SpeechRecognition.setPTTState({} as PTTStateOptions);

getSupportedLanguages

获取底层识别器支持的语言列表。

Android 13+ 设备不再暴露此列表；在这种情况下 languages 是空的。

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

await SpeechRecognition.getSupportedLanguages();

isListening

Returns whether the plugin is actively listening for speech.

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

await SpeechRecognition.isListening();

checkPermissions

Gets the current permission state.

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

await SpeechRecognition.checkPermissions();

requestPermissions

Requests the microphone + speech recognition permissions.

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

await SpeechRecognition.requestPermissions();

类型参考

SpeechRecognitionAvailability

export interface SpeechRecognitionAvailability {
  available: boolean;
}

SpeechRecognitionStartOptions

配置识别器在调用时的行为

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

选项

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

结果

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

Options for .

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

由 checkPermissions 和 requestPermissions.

export interface SpeechRecognitionPermissionStatus {
  speechRecognition: PermissionState;
}

SpeechRecognitionSegmentResultEvent

仅在 Android 上产生分段结果时触发

export interface SpeechRecognitionSegmentResultEvent {
  matches: string[];
}

SpeechRecognitionPartialResultEvent

每当产生部分转录时都会引发。

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

当监听状态发生变化时会引发。

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';
}

真理来源

本页面由插件生成 src/definitions.ts重新运行同步时，公共API上游发生变化。

继续从开始使用

如果您正在使用 Getting Started 来规划仪表板和API操作，连接它与 使用@capgo/capacitor-speech-recognition 为native能力在使用@capgo/capacitor-speech-recognition API概述 为API概述的实现细节 介绍 为介绍的实现细节 API密钥 为API密钥的实现细节 设备 设备的实现细节