emakefun::Tts类 参考

语音合成模块 更多...

#include <tts.h>

Public 类型
enum	ErrorCode : uint32_t {   kOK = 0 , kI2cDataTooLongToFitInTransmitBuffer = 1 , kI2cReceivedNackOnTransmitOfAddress = 2 , kI2cReceivedNackOnTransmitOfData = 3 ,   kI2cOtherError = 4 , kI2cTimeout = 5 , kInvalidParameter = 6 , kUnknownError = 7 }
	错误码 更多...
enum	TextEncodingType : uint8_t {   kGb23212 = 0x00 , kGbk = 0x01 , kBig5 = 0x02 , kUtf16le = 0x03 ,   kUtf8 = 0x04 }
	文本编码类型 更多...

Public 成员函数
	Tts (const uint8_t i2c_address=kDefaultI2cAddress, TwoWire &wire=Wire)
	构造函数
	Tts (TwoWire &wire)
ErrorCode	Initialize ()
	初始化函数
ErrorCode	Play (const String &text, const TextEncodingType text_encoding_type=kUtf8)
	文本转语音并播放
ErrorCode	PlayFromCache (const TextEncodingType text_encoding_type=kUtf8, uint8_t count=kMinSpeechCount)
	从缓存块0的文本开始转语音并播放
ErrorCode	PushTextToCache (const String &text, const uint8_t cache_index)
	将文本内容上传到指定缓存块
ErrorCode	Stop ()
	停止播放
ErrorCode	Pause ()
	暂停播放
ErrorCode	Resume ()
	恢复播放

静态 Public 属性
static constexpr uint8_t	kDefaultI2cAddress = 0x40
	语音合成模块默认I2C地址
static constexpr uint8_t	kMaxTextBytesSize = 250
	文本数据最大字节数
static constexpr uint8_t	kMaxCacheIndex = 15
	缓存块索引最大值
static constexpr uint8_t	kMinSpeechCount = 1
	从缓存合成播放次数的最小值
static constexpr uint8_t	kMaxSpeechCount = 15
	从缓存合成播放次数的最大值

详细描述

语音合成模块

示例

play.ino, play_flow_control.ino, play_from_cache.ino , 以及 play_with_parameters.ino.

成员枚举类型说明

ErrorCode

enum emakefun::Tts::ErrorCode : uint32_t

错误码

枚举值
kOK	0：成功
kI2cDataTooLongToFitInTransmitBuffer	1：I2C数据太长，无法装入传输缓冲区
kI2cReceivedNackOnTransmitOfAddress	2：在I2C发送地址时收到NACK
kI2cReceivedNackOnTransmitOfData	3：在I2C发送数据时收到NACK
kI2cOtherError	4：其他I2C错误
kI2cTimeout	5：I2C通讯超时
kInvalidParameter	6：参数错误
kUnknownError	7: 未知错误

TextEncodingType

enum emakefun::Tts::TextEncodingType : uint8_t

文本编码类型

枚举值
kGb23212	GB2312
kGbk	GBK
kBig5	BIG5
kUtf16le	UTF16LE
kUtf8	UTF8

构造及析构函数说明

Tts()

emakefun::Tts::Tts ( const uint8_t i2c_address = kDefaultI2cAddress, TwoWire & wire = Wire )

explicit

构造函数

参数

di2c_address

语音合成模块I2C地址，默认为0x40

成员函数说明

Initialize()

ErrorCode emakefun::Tts::Initialize

(

)

初始化函数

返回

返回值请参考 ErrorCode

Pause()

ErrorCode emakefun::Tts::Pause

(

)

暂停播放

返回

返回值请参考 ErrorCode

Play()

ErrorCode emakefun::Tts::Play	(	const String &	text,
		const TextEncodingType	text_encoding_type = kUtf8 )

文本转语音并播放

参数

[in]	text	文本数据，数据长度不大于250个字节
[in]	text_encoding_type	文本编码类型，参考 TextEncodingType, 默认为 kUtf8

返回

返回值请参考 ErrorCode

PlayFromCache()

ErrorCode emakefun::Tts::PlayFromCache	(	const TextEncodingType	text_encoding_type = kUtf8,
		uint8_t	count = kMinSpeechCount )

从缓存块0的文本开始转语音并播放

参数

[in]	text_encoding_type	文本编码类型，参考 TextEncodingType，默认为 kUtf8
[in]	synthesizing_count	合成播放次数，范围 1 ~ 15

返回

返回值请参考 ErrorCode

PushTextToCache()

ErrorCode emakefun::Tts::PushTextToCache	(	const String &	text,
		const uint8_t	cache_index )

将文本内容上传到指定缓存块

参数

[in]	text	文本数据，数据长度不大于250个字节
[in]	cache_index	缓存块索引，范围 0 ~ 15

返回

返回值请参考 ErrorCode

Resume()

ErrorCode emakefun::Tts::Resume

(

)

恢复播放

返回

返回值请参考 ErrorCode

Stop()

ErrorCode emakefun::Tts::Stop

(

)

停止播放

返回

返回值请参考 ErrorCode

---

该类的文档由以下文件生成:

• src/tts.h