
文本到语音
@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(...)stop()getSupportedLanguages()getSupportedVoices()isLanguageSupported(...)openInstall()addListener('onRangeStart', ...)- 接口
- 数字
说话(...)
speak(options: TTSOptions) => Promise<void>
启动 TTS 引擎并播放想要的文本 .
| 参数 | 类型 |
|---|---|
options | TTSOptions |
停止( )
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 | 类型 | 说明 | 默认 | 自兹 |
|---|---|---|---|---|
text | string | 语出后会合成的文字. | ||
lang | string | 出言之语. 可以使用 getSupportedLanguages。 。 。 . | "en-US" | |
rate | number | 说话的速度. | 1.0 | |
pitch | number | 说话的音响. | 1.0 | |
volume | number | 语音的音量. | 1.0 | |
voice | number | 用于说话的选定语音索引 。 可用 getSupportedVoices。 。 。 . | ||
category | string | 选择 iOS 音频会话分类 。 可能的数值 : ambient 财务报告和审定财务报表 playback启用 playback 用于播放音频,即使应用程序处于背景状态。 仅供iOS使用. | "ambient" | |
queueStrategy | QueueStrategy | 选择多个发言请求重叠时要采用的策略 . | QueueStrategy.Flush | 5.1.0 国家 |
语音合成
这个 语音合成 接口代表系统支持的声音.
| Prop | 类型 | 说明 |
|---|---|---|
default | boolean | 指定语音是否为当前应用程序的默认语音( S)true)或不(false) (中文(简体) ). |
lang | string | BCP 47语言标记表示语音语言. |
localService | boolean | 指定该语音是否由本地(true)或远程(false) 语音合成器服务. |
name | string | 代表声音的人类可读名. |
voiceURI | string | 此语音的URI类型和语音合成服务位置. |
插件听筒
| Prop | 类型 |
|---|---|
remove | () => Promise<void> |
数字
队列战略
| 成员 | 数值 | 说明 |
|---|---|---|
Flush | 0 | 使用 Flush 当新请求发出时, 停止当前请求. |
Add | 1 | 使用 Add 以缓冲语音请求。 请求将在所有先前的请求完成后执行. |
更改日志
见 变动情况。 。 。 .
许可证
见 自由主义。 。 。 .