@capgo/capacitor-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_KEEP_0__ リポジトリ
使用@capgo/capacitor-speech-synthesisを続けてください。
使用中の@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-speech-synthesis @Capacitor/ capgo/capacitor-speech-synthesis __CAPGO_KEEP_0__/__CAPGO_KEEP_1__-speech-synthesis @capgo/capacitor-speech-synthesis @capgo/capacitor-speech-synthesis はじめに Getting Started Capgo Plugin Directory Capgo Plugin Directory Capacitor Capgoのプラグイン Capacitor Plugins by Capgo プラグインの追加または更新 Adding or Updating Plugins