@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 - 立即暂停语音朗读。

公开 API

方法	描述
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 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 关于“添加或更新插件”中的实现细节，以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。