Getting Started

このプラグインのインストール手順とマークダウンガイドをコピーする

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-speech-recognition`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/speech-recognition/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-speech-recognition` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してください。以下のプラットフォーム固有の説明を参照してください。

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 結果は、現在のデバイス、OSバージョン、ロケールがそのプラットフォームで利用できる最新のオンデバイスパスを使用できることを意味します。

結果は、デバイスがのみレガシーアプリケーション認識パスをサポートしている場合に返されます。 false 結果

Platform SDK docs: iOS: iOS: Speech 音声認識

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

await SpeechRecognition.isOnDeviceRecognitionAvailable();

`start`

音声のキャプチャと音声認識を開始します。

もし partialResults が 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 の場合、この最初に正常停止を試みて、次に破棄/再作成にフォールバックします。 timeout. iOS の場合、現在のセッションは即座に停止されます。

キャッシュされた部分的なトランスクリプションがあれば、リスナーに次の形式で送信されます。 partialResults リスナーに forced: true.

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

await SpeechRecognition.forceStop();

`getLastPartialResult`

最後のキャッシュされた部分的なトランスクリプション結果を取得します。

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`

プラグインが音声の入力を待っている状態かどうかを返します。

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

await SpeechRecognition.isListening();

`checkPermissions`

現在の許可状態を取得します。

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

await SpeechRecognition.checkPermissions();

`requestPermissions`

マイクと音声認識の許可を要求します。

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

await SpeechRecognition.requestPermissions();

型参照

`SpeechRecognitionAvailability`

export interface SpeechRecognitionAvailability {
  available: boolean;
}

`SpeechRecognitionStartOptions`

__CAPGO_KEEP_0__を呼び出すときに認識器の動作を設定します。

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`

のオプション

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

真実の源

公開された__CAPGO_KEEP_0__がアップストリームで変更されたときに再度同期してください。 src/definitions.ts. Re-run the sync when the public API changes upstream.

続けて始めましょう

Capgoを使用している場合 Getting Started APIの設定と管理を行うには、Capgoを Capacitorを使用して、@capgo/capacitor-speech-recognition for the native capability in Using @capgo/capacitor-speech-recognition, APIの概要 APIの実装 __CAPGO_KEEP_0__のキーアクセス __CAPGO_KEEP_0__の実装 API Keys API __CAPGO_KEEP_1__ デバイスの実装詳細について。