TTS模块

说明： 本模块首批接口从API version 1开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

 

简介

本模块提供文字转语音的功能。

导入模块

import tts from '@system.tts';

init¹⁺

init(): boolean

初始化TTS模块。

系统能力：

返回值：

类型	说明
boolean	模块初始化的结果，true为成功，false为失败。

示例：

var err = tts.init();
if (err == true) {
    console.log('tts init succ');
} else {
    console.error('tts init error');
}       

EncodeType¹⁺

枚举，文本编码类型。

默认值	名称	描述
0x00	ENCODE_ISO8859_1	ISO8859_1编码
0x01	ENCODE_UTF8	UTF8编码
0x02	ENCODE_UTF16BE	UTF16BE编码
0x03	ENCODE_UTF16LE	UTF16LE编码
0x04	ENCODE_GSM	GSM编码
0x05	ENCODE_CP936	CP936编码
0x06	ENCODE_IRA	IRA编码

play¹⁺

play(text: string, encode: EncodeType): boolean

开始播放文本。

返回值：

类型	说明
boolean	播放的结果，true为成功，false为失败。

示例：

var err = tts.play("123456", 1);
if (err == true) {
    console.log('tts play succ');
} else {
    console.error('tts play error');
}

isPlaying¹⁺

isPlaying(): boolean

是否正在播放。

返回值：

类型	说明
boolean	模块的播放状态，true为正在播放，false为停止。

示例：

var err = tts.isPlaying();
if (err == true) {
    console.log('tts is playing now');
} else {
    console.error('tts is stop');
}

stop¹⁺

stop(): boolean

停止播放文本。

返回值：

类型	说明
boolean	停止播放的结果，true为成功，false为失败

示例：

var err = tts.stop();
if (err == true) {
    console.log('tts stop succ');
} else {
    console.error('tts stop error');
}

destroy¹⁺

destroy(): boolean

反初始化。

返回值：

类型	说明
boolean	反初始化的结果，true为成功，false为失败。

示例：

var err = tts.destroy();
if (err == true) {
    console.log('tts destroy succ');
} else {
    console.error('tts destroy error');
}