@nativescript-community/texttospeech
适用于 Android 和 iOS 的文本转语音 NativeScript 插件
npm i --save @nativescript-community/texttospeech
- 版本:3.1.2
- GitHub: https://github.com/nativescript-community/texttospeech
- NPM: https://npmjs.net.cn/package/%40nativescript-community%2Ftexttospeech
- 下载
- 昨日:22
- 上周:80
- 上月:189
@nativescript-community/texttospeech :loudspeaker
适用于 Android 和 iOS 的文本转语音 NativeScript 插件
原生控件
- Android - TextToSpeech
- iOS - AVSpeechSynthesizer
安装
从项目的根目录运行以下命令
tns plugin add @nativescript-community/texttospeech
此命令会自动安装必要的文件,并将 @nativescript-community/texttospeech 作为依赖项存储在项目的 package.json 文件中。
视频教程
egghead 课程 @ https://egghead.io/lessons/typescript-using-text-to-speech-with-nativescript
用法
/// javascript
const TextToSpeech = require('@nativescript-community/texttospeech');
/// TypeScript
import { TNSTextToSpeech, SpeakOptions } from '@nativescript-community/texttospeech';
const TTS = new TNSTextToSpeech();
const speakOptions: SpeakOptions = {
text: 'Whatever you like', /// *** required ***
speakRate: 0.5, // optional - default is 1.0
pitch: 1.0, // optional - default is 1.0
volume: 1.0, // optional - default is 1.0
locale: 'en-GB', // optional - default is system locale,
finishedCallback: Function, // optional
};
// Call the `speak` method passing the SpeakOptions object
TTS.speak(speakOptions).then(
() => {
// everything is fine
},
(err) => {
// oops, something went wrong!
}
);
API
-
speak(options: SpeakOptions): Promise<any>
- 使用给定选项开始说话 -
pause(): void
- 暂停说话 -
resume(): void
- 继续说话 -
destroy(): void
- 释放语音合成器/引擎的资源 -
SpeakOptions = {}
text: string
**必需**queue?: boolean = false
pitch?: number = 1.0
speakRate?: number = 1.0
volume?: number = 1.0
locale?: string = default system locale or language
finishedCallback?: Function
如果您希望设置自定义区域设置,您需要提供一个有效的 BCP-47 代码,例如 en-US
。如果您只想设置自定义语言(不带首选国家/地区代码),您需要提供一个有效的 ISO 639-1 语言代码。
插件会检查提供的区域代码是否有正确的语法,但不会阻止设置不存在的代码。请谨慎使用此功能。
仅使用语言代码的示例
const speakOptions: SpeakOptions = {
text: 'Whatever you like', // *** required ***
locale: 'en', // english language will be used
};
使用区域设置的示例
const speakOptions: SpeakOptions = {
text: 'Whatever you like', // *** required ***
locale: 'en-AU', // australian english language will be used
};
提示
- 大多数设备上,语音合成器需要一点时间来初始化。一种简单的方法是在演示应用中测试过的是,创建您的新 TNSTextToSpeech 实例,然后立即调用
init
方法。这将强制合成器“热身”。现在,当您调用应用程序功能的speak
方法时,合成器已经“热身”,因此延迟应该很小。这种“热身”过程可能被放入插件源本身,我现在没有时间做这件事,但欢迎任何经过良好测试的贡献,使其成为合成器的默认行为。
仅 Android 的方法
getAvailableLanguages(): Promise<Array<Language>>;
- 返回可用的语言数组(用于防止使用不存在的语言/区域代码)
致谢
灵感来源于 James Montemagno 的 TextToSpeech Xamarin 插件
感谢 anarchicknight 提供此插件。感谢 stefalda 在暂停/恢复和 finishedCallback 事件上的出色工作 :bomb