@capacitor-community/text-to-speech

中文文档
8.0.2发布于 2026/06/15MITTypeScriptESM + CJS零依赖近 30 天下载 32.5万

从文本中合成语音的电容插件 .

中文使用文档
文档目录18 节
  1. 文本到语音
  2. 维护者
  3. 安装
  4. 配置
  5. 演示
  6. 使用量
  7. API 密码
  8. 说话(...)
  9. 停止( )
  10. 获取支持语言( )
  11. 获得支持的声音( )
  12. 语言支持(...)
  13. 打开Install ()
  14. 添加 Listener ('on RangeStart', ...) 键入
  15. 接口
  16. 数字
  17. 更改日志
  18. 许可证


文本到语音

@capacitor-community/text-to-speech

从文本中合成语音的电容社区插件 .


维护者

维护者GitHub 图像社会
罗宾·根兹抢劫@robin genz (中文(简体) )

安装

npm install @capacitor-community/text-to-speech
npx cap sync

配置

此插件不需要配置 .

演示

这里有一个实例: robingenz/电容器-插管-demo

使用量

import { TextToSpeech } from '@capacitor-community/text-to-speech';

const speak = async () => {
  await TextToSpeech.speak({
    text: 'This is a sample text.',
    lang: 'en-US',
    rate: 1.0,
    pitch: 1.0,
    volume: 1.0,
    category: 'ambient',
    queueStrategy: 1
  });
};

const stop = async () => {
  await TextToSpeech.stop();
};

const getSupportedLanguages = async () => {
  const languages = await TextToSpeech.getSupportedLanguages();
};

const getSupportedVoices = async () => {
  const voices = await TextToSpeech.getSupportedVoices();
};

const isLanguageSupported = async (lang: string) => {
  const isSupported = await TextToSpeech.isLanguageSupported({ lang });
};

API 密码

说话(...)

speak(options: TTSOptions) => Promise<void>

启动 TTS 引擎并播放想要的文本 .

参数类型
optionsTTSOptions

停止( )

stop() => Promise<void>

停止TTS引擎.


获取支持语言( )

getSupportedLanguages() => Promise<{ languages: string[]; }>

返回支持的 BCP 47 语言标记列表 .

回返情况: Promise<{ languages: string[]; }>


获得支持的声音( )

getSupportedVoices() => Promise<{ voices: SpeechSynthesisVoice[]; }>

返回一个支持的声音列表 .

回返情况: Promise<{ voices: SpeechSynthesisVoice[]; }>


语言支持(...)

isLanguageSupported(options: { lang: string; }) => Promise<{ supported: boolean; }>

检查是否支持特定的 BCP 47 语言标记 .

参数类型
options{ lang: string; }

回返情况: Promise<{ supported: boolean; }>


打开Install ()

openInstall() => Promise<void>

核实系统中资源文件的适当安装和可用性.

仅供Android使用.


添加 Listener ('on RangeStart', ...) 键入

addListener(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>
参数类型
eventName'onRangeStart'
listenerFunc(info: { start: number; end: number; spokenWord: string; }) => void

回返情况: Promise<PluginListenerHandle>


接口

TTS 选项

Prop类型说明默认自兹
textstring语出后会合成的文字.
langstring出言之语. 可以使用 getSupportedLanguages。 。 。 ."en-US"
ratenumber说话的速度.1.0
pitchnumber说话的音响.1.0
volumenumber语音的音量.1.0
voicenumber用于说话的选定语音索引 。 可用 getSupportedVoices。 。 。 .
categorystring选择 iOS 音频会话分类 。 可能的数值 : ambient 财务报告和审定财务报表 playback启用 playback 用于播放音频,即使应用程序处于背景状态。 仅供iOS使用."ambient"
queueStrategyQueueStrategy选择多个发言请求重叠时要采用的策略 .QueueStrategy.Flush5.1.0 国家

语音合成

这个 语音合成 接口代表系统支持的声音.

Prop类型说明
defaultboolean指定语音是否为当前应用程序的默认语音( S)true)或不(false) (中文(简体) ).
langstringBCP 47语言标记表示语音语言.
localServiceboolean指定该语音是否由本地(true)或远程(false) 语音合成器服务.
namestring代表声音的人类可读名.
voiceURIstring此语音的URI类型和语音合成服务位置.

插件听筒

Prop类型
remove() => Promise<void>

数字

队列战略

成员数值说明
Flush0使用 Flush 当新请求发出时, 停止当前请求.
Add1使用 Add 以缓冲语音请求。 请求将在所有先前的请求完成后执行.

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

版本与发布记录

@capacitor-community/text-to-speech 共发布 47 个版本,首次发布于 2020/06/24;过去 12 个月发布了 3 个版本。

版本发布日期距今
8.0.2latest2026/06/154 个月前
8.0.12026/06/075 个月前
8.0.02026/01/319 个月前
6.1.02025/10/241 年前
6.0.02025/01/291.8 年前
5.1.0-dev.cf04aa9.1738003753dev2025/01/281.8 年前

关于 @capacitor-community/text-to-speech 的常见问题

@capacitor-community/text-to-speech 是什么?

从文本中合成语音的电容插件 .

如何安装 @capacitor-community/text-to-speech?

在项目目录运行 npm install @capacitor-community/text-to-speech,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capacitor-community/text-to-speech 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@capacitor-community/text-to-speech 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@capacitor-community/text-to-speech 可以商用吗?

@capacitor-community/text-to-speech 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@capacitor-community/text-to-speech 的下载量有多少?

根据 npm 官方下载统计,@capacitor-community/text-to-speech 在 2026/10/09 – 2026/11/07 这 30 天内被下载 325,001 次,日均约 10,833 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@capacitor-community/text-to-speech 还在维护吗?

最新版本 8.0.2 发布于 2026/06/15(4 个月前);至今共发布 47 个版本,其中过去 12 个月发布了 3 个;首次发布于 2020/06/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。