@capgo/capacitor-speech-synthesis

概要

@capgo/capacitor-speech-synthesis アクセシビリティ、言語学習、ハンズフリー操作のために、プラットフォームのテキスト読み上げエンジンを駆動します。音声の選択、速度やピッチの調整、長い文章の一時停止や再開が可能です。また、iOSおよびAndroid向けにオーディオファイルをレンダリングし、オフライン再生にも対応しています。

呼び出す initialize() iOSで最初の読み上げを高速化する場合、および activateAudioSession() 特定のiOSオーディオカテゴリが必要な場合に使用します。

プラットフォーム対応

プラットフォーム	サポート	備考
iOS	はい	AVSpeechSynthesizer、オーディオセッションヘルパー
Android	はい	Android TTSエンジン
Web	一部	利用可能なブラウザの音声合成機能

主要機能

• speak - 指定したオプションでテキストを読み上げます。読み上げは音声キューに追加されます。
• synthesizeToFile - 音声をオーディオファイルとして書き出します（Android/iOSのみ）。保存されたファイルのパスを返します。
• cancel - キューにあるすべての読み上げをキャンセルし、現在の音声を停止します。
• pause - 音声を即座に一時停止します。

公開 API

メソッド	説明
speak	指定したオプションでテキストを読み上げます。読み上げ内容はスピーチキューに追加されます。
synthesizeToFile	音声を合成してオーディオファイルに書き出します (Android/iOSのみ)。保存した音声のファイルパスを返します。
cancel	キューにあるすべての発話をキャンセルし、現在の読み上げを停止します。
pause	読み上げを即座に一時停止します。
resume	一時停止した読み上げを再開します。
isSpeaking	音声合成が現在読み上げ中かどうかを確認します。
isAvailable	デバイスで音声合成が利用可能か確認します。
getVoices	利用可能なすべての音声を取得します。
getLanguages	利用可能なすべての言語を取得します。
isLanguageAvailable	特定の言語が利用可能か確認します。
isVoiceAvailable	特定の音声が利用可能か確認します。
initialize	音声合成エンジンを初期化します (iOS向け最適化)。初回の音声リクエストのレイテンシを抑えられます。
activateAudioSession	特定のカテゴリでオーディオセッションを有効にします (iOSのみ)。
deactivateAudioSession	オーディオセッションを非アクティブ化します（iOSのみ）。
getPluginVersion	ネイティブプラグインのバージョンを取得します。
addListener	音声の読み上げが開始されたときに実行されます。
addListener	音声の読み上げが終了したときに実行されます。
addListener	音声再生中の単語の区切りを検知します。
addListener	合成エラーを検知します。
removeAllListeners	すべてのイベントリスナーを削除します。

信頼できる情報源

このリファレンスは以下から同期されています： src/definitions.ts 内の capacitor-speech-synthesis.

@capgo/capacitor-speech-synthesisの続き

以下を使用している場合： @capgo/capacitor-speech-synthesis ネイティブプラグインの作業を計画するには、それを以下と連携させる @capgo/capacitor-speech-synthesis の使用 「@capgo/capacitor-speech-synthesis の使用」のネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリでのプロダクトワークフロー向けに、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加・更新 実装の詳細は Adding or Updating Plugins を、 Ionic Enterprise プラグインの代替案 製品ワークフローは Ionic Enterprise Plugin Alternatives を参照してください。