メインコンテンツへスキップ

@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 - 読み上げを即座に一時停止します。
メソッド説明
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/capacitor-speech-synthesis のネイティブ機能を使用する際の Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。