メインコンテンツへスキップ
@capgo/capacitor-speech-synthesis メディア オープンソース

音声合成 Capacitor プラグイン

言語、声、ピッチ、速度、音量を自在にコントロールして、テキストから音声を合成します。

インストール

bun add @capgo/capacitor-speech-synthesis bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-speech-synthesis
  • pnpm add @capgo/capacitor-speech-synthesis
  • yarn add @capgo/capacitor-speech-synthesis

ガイド

Capacitor で Speech Synthesis を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Speech Synthesis プラグインのプレビューQR code

@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 Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

Speech Synthesis プラグイン FAQ

Capacitor アプリに Speech Synthesis プラグインをインストールするにはどうすればよいですか?

「bun add @capgo/capacitor-speech-synthesis」(または「npm install @capgo/capacitor-speech-synthesis」)を実行し、続けて「bunx cap sync」を実行して、iOS と Android プロジェクトにネイティブの code を反映させてください。アプリの code で「@capgo/capacitor-speech-synthesis」からインポートしてください。

@capgo/capacitor-speech-synthesis は React、Vue、Angular で動作しますか?

はい。Speech Synthesis は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 上で動くあらゆる Web フレームワークで使えます。

@capgo/capacitor-speech-synthesis はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-speech-synthesis は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-speech-synthesis/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストも歓迎します。

App Store の審査なしで、Speech Synthesis を使用している code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに Speech Synthesis の変更を配信

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める