@capgo/capacitor-speech-synthesis の使い方
テキストから音声を合成する Speech Synthesis プラグイン。
インストール
bun add @capgo/capacitor-speech-synthesis
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
API の概要
| メソッド | 説明 |
|---|---|
speak |
指定したオプションでテキストを読み上げます。読み上げ内容はスピーチキューに追加されます。 |
synthesizeToFile |
音声をオーディオファイルとして書き出します(Android/iOSのみ)。保存されたファイルのパスを返します。 |
cancel |
キューにあるすべての読み上げをキャンセルし、現在の音声を停止します。 |
pause |
音声を即座に一時停止します。 |
resume |
一時停止中の音声を再開します。 |
isSpeaking |
現在、音声合成が再生中かどうかを確認します。 |
isAvailable |
デバイスで音声合成が利用可能か確認します。 |
getVoices |
利用可能なすべての音声を取得します。 |
getLanguages |
利用可能なすべての言語を取得します。 |
isLanguageAvailable |
特定の言語が利用可能か確認します。 |
isVoiceAvailable |
特定の音声が利用可能か確認します。 |
initialize |
音声合成エンジンを初期化します(iOS向けに最適化)。これにより、初回再生時のレイテンシを低減できます。 |
activateAudioSession |
特定のカテゴリでオーディオセッションを有効にします(iOSのみ)。 |
deactivateAudioSession |
オーディオセッションを無効にします(iOSのみ)。 |
例
speak()
指定したオプションでテキストを読み上げます。読み上げ内容はキューに追加されます。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
const result = await SpeechSynthesis.speak({
text: 'Hello, world!',
language: 'en-US',
rate: 1.0,
pitch: 1.0,
volume: 1.0,
queueStrategy: 'Add'
});
console.log('Utterance ID:', result.utteranceId);
synthesizeToFile()
音声をオーディオファイルとして書き出します(Android/iOSのみ)。保存されたファイルのパスを返します。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
const result = await SpeechSynthesis.synthesizeToFile({
text: 'Hello, world!',
language: 'en-US'
});
console.log('Audio file saved at:', result.filePath);
cancel()
キューにあるすべての読み上げをキャンセルし、現在の再生を停止します。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.cancel();
pause()
再生を即座に一時停止します。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.pause();
resume()
一時停止中の再生を再開します。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
await SpeechSynthesis.resume();
isSpeaking()
現在、音声合成が再生中かどうかを確認します。
import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';
const { isSpeaking } = await SpeechSynthesis.isSpeaking();
console.log('Is speaking:', isSpeaking);
上記の表には14個のコアメソッドが記載されています。リスナーやバージョンヘルパー、および各メソッドの詳細な仕様については、 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または SpeechSynthesis.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
@capgo/capacitor-speech-synthesis の使用方法から続ける
使用している場合 @capgo/capacitor-speech-synthesis の使い方 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-speech-synthesis @capgo/capacitor-speech-synthesis の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細、および プラグインの追加または更新 「プラグインの追加または更新」の実装詳細については、