跳转至正文

语音合成 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 App,然后扫描二维码 code。

Speech Synthesis 插件预览 QR code

使用 @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/capacitor-speech-synthesis

如果你正在使用 使用 @capgo/capacitor-speech-synthesis 要规划原生插件工作,请将其与 @capgo/capacitor-speech-synthesis 有关 @capgo/capacitor-speech-synthesis 中的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Speech Synthesis 插件常见问题

如何在 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 package,因此可用于任何运行在 Capacitor 中的 Web framework,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-speech-synthesis 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-speech-synthesis 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-speech-synthesis/,并且可以从 npm 免费安装。欢迎提交 Bug 报告和 pull request。

我可以在不经过 App Store 审核的情况下,更新使用了 Speech Synthesis 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布语音合成更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo