xt-sdk 文档 v1.0.3
xt-sdk 嵌入式 SDK API 参考
载入中...
搜索中...
未找到
xt_audio_tts(TTS 语音合成)

XTINY 音频 TTS 合成模块接口 更多...

结构体

struct  xt_audio_tts_cb_info
 TTS 回调信息结构体 更多...
struct  xt_audio_tts_info
 TTS 播放扩展参数结构体 更多...
struct  xt_audio_tts_config
 TTS 配置结构体 更多...

宏定义

#define xt_audio_tts_play(_hdl, _text, _size, _prior, _level)

类型定义

typedef struct xt_audio_tts * xt_audio_tts_t
 TTS 实例句柄类型
typedef void(* xt_audio_tts_cb_t) (xt_audio_t hdl, enum xt_audio_tts_evt evt, struct xt_audio_tts_cb_info *info)
 TTS 回调函数类型

枚举

enum  xt_audio_tts_evt {
  XT_AUDIO_TTS_EVT_NO_ERR , XT_AUDIO_TTS_EVT_SYNTHESIZE_CHUNK , XT_AUDIO_TTS_EVT_SYNTHESIZE_CMPLT , XT_AUDIO_TTS_EVT_SYNTHESIZE_ABORT ,
  XT_AUDIO_TTS_EVT_SYNTHESIZE_ERROR , _XT_AUDIO_TTS_EVT_MAX
}
 TTS 事件枚举 更多...
enum  xt_tts_res_location { XT_AUDIO_TTS_RES_LOC_INTERNAL = 0 , XT_AUDIO_TTS_RES_LOC_EXTERNAL }
 TTS 资源位置类型枚举 更多...

函数

xt_err_t xt_audio_tts_set_resource_location (enum xt_tts_res_location loc, char *part_name)
 设置 TTS 资源位置
xt_err_t xt_audio_tts_setup (struct xt_audio_tts_config *cfg, xt_audio_t *hdl)
 初始化 TTS 模块
xt_err_t xt_audio_tts_close (xt_audio_t hdl)
 关闭 TTS 模块
int xt_audio_tts_play_ext (xt_audio_t hdl, const char *text, uint32_t size, struct xt_audio_tts_info *info)
 TTS 播放(扩展版本)
xt_err_t xt_audio_tts_stop (xt_audio_t hdl)
 停止 TTS 播放
int xt_audio_tts_is_stopping (xt_audio_t hdl)
 查询 TTS 是否正在停止

详细描述

XTINY 音频 TTS 合成模块接口

宏定义说明

◆ xt_audio_tts_play

#define xt_audio_tts_play ( _hdl,
_text,
_size,
_prior,
_level )
值:
xt_audio_tts_play_ext(_hdl, _text, _size, &((struct xt_audio_tts_info){.prior = _prior, .level = _level}))
int xt_audio_tts_play_ext(xt_audio_t hdl, const char *text, uint32_t size, struct xt_audio_tts_info *info)
TTS 播放(扩展版本)
TTS 播放扩展参数结构体

在文件 xt_audio_tts.h 第 141 行定义.

类型定义说明

◆ xt_audio_tts_cb_t

typedef void(* xt_audio_tts_cb_t) (xt_audio_t hdl, enum xt_audio_tts_evt evt, struct xt_audio_tts_cb_info *info)

TTS 回调函数类型

参数
hdl音频设备句柄
evtTTS 事件,见 xt_audio_tts_evt
info回调信息,见 xt_audio_tts_cb_info

在文件 xt_audio_tts.h 第 69 行定义.

◆ xt_audio_tts_t

typedef struct xt_audio_tts* xt_audio_tts_t

TTS 实例句柄类型

在文件 xt_audio_tts.h 第 36 行定义.

枚举类型说明

◆ xt_audio_tts_evt

TTS 事件枚举

枚举值
XT_AUDIO_TTS_EVT_NO_ERR 

无错误

XT_AUDIO_TTS_EVT_SYNTHESIZE_CHUNK 

合成了一段音频数据

XT_AUDIO_TTS_EVT_SYNTHESIZE_CMPLT 

合成完成

XT_AUDIO_TTS_EVT_SYNTHESIZE_ABORT 

合成被中止

XT_AUDIO_TTS_EVT_SYNTHESIZE_ERROR 

合成出错

_XT_AUDIO_TTS_EVT_MAX 

事件数量(内部使用)

在文件 xt_audio_tts.h 第 41 行定义.

◆ xt_tts_res_location

TTS 资源位置类型枚举

枚举值
XT_AUDIO_TTS_RES_LOC_INTERNAL 

内部资源(默认)

XT_AUDIO_TTS_RES_LOC_EXTERNAL 

外置 Flash

在文件 xt_audio_tts.h 第 96 行定义.

函数说明

◆ xt_audio_tts_close()

xt_err_t xt_audio_tts_close ( xt_audio_t hdl)

关闭 TTS 模块

参数
hdlTTS 句柄
返回
xt_err_t XT_EOK 成功,其他失败

◆ xt_audio_tts_is_stopping()

int xt_audio_tts_is_stopping ( xt_audio_t hdl)

查询 TTS 是否正在停止

参数
hdlTTS 句柄
返回
int 非 0 表示正在停止,0 表示未在停止

◆ xt_audio_tts_play_ext()

int xt_audio_tts_play_ext ( xt_audio_t hdl,
const char * text,
uint32_t size,
struct xt_audio_tts_info * info )

TTS 播放(扩展版本)

参数
hdlTTS 句柄
textUTF-8 文本
size文本字节数
info扩展参数(可为 NULL),见 xt_audio_tts_info
返回
int 0 成功,负数为错误码

◆ xt_audio_tts_set_resource_location()

xt_err_t xt_audio_tts_set_resource_location ( enum xt_tts_res_location loc,
char * part_name )

设置 TTS 资源位置

参数
loc资源位置,见 xt_tts_res_location
part_name外置 Flash 分区名,仅当 loc 为 XT_AUDIO_TTS_RES_LOC_EXTERNAL 时有效, 传入 NULL 时使用默认分区 "ext_tts"
返回
xt_err_t XT_EOK 成功,其他失败

◆ xt_audio_tts_setup()

xt_err_t xt_audio_tts_setup ( struct xt_audio_tts_config * cfg,
xt_audio_t * hdl )

初始化 TTS 模块

参数
cfg配置参数,见 xt_audio_tts_config
hdl输出 TTS 句柄
返回
xt_err_t XT_EOK 成功,其他失败

◆ xt_audio_tts_stop()

xt_err_t xt_audio_tts_stop ( xt_audio_t hdl)

停止 TTS 播放

参数
hdlTTS 句柄
返回
xt_err_t XT_EOK 成功,其他失败