@capgo/capacitor-speech-synthesis アクセシビリティ、言語学習、ハンズフリーナビゲーションのためのプラットフォームのテキスト読み上げエンジンを駆動します。音声を選択し、速度やピッチを調整し、長い文章の一時停止や再開を行い、iOS と Android でオフライン再生用のオーディオファイルをレンダリングできます。
呼び出す initialize() iOSで最初の発話を速くするために、および activateAudioSession() 特定のiOSオーディオカテゴリが必要な場合。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | AVSpeechSynthesizer、オーディオセッションヘルパー |
| Androidでは | はい | Android TTSエンジン |
| Web | 一部 | 利用可能な場合はブラウザの音声合成 |
コア機能
「コア機能」セクションspeak- 指定したオプションでテキストを読み上げます。読み上げは音声キューに追加されます。synthesizeToFile- 音声をオーディオファイルに合成します (Android/iOSのみ)。保存先のファイルパスを返します。cancel- キューにあるすべての読み上げをキャンセルし、現在の読み上げを停止します。pause- 読み上げを即座に一時停止します。
公開 API
「Public 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 | すべてのイベントリスナーを削除します。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています: src/definitions.ts における capacitor-speech-synthesis.
@capgo/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 プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。