# SparkChain 在线语音合成 Linux SDK集成文档

# 1. 在线语音合成简介

在线语音合成流式接口将文字信息转化为声音信息，同时提供了众多极具特色的发音人（音库）供您选择。具体发音人参考功能参数配置。

注意：在使用该能力前，需要开通相应的授权。

小语种及少数民族方言：

• 目前新增：韩语、日语、维吾尔语、藏语、法语、俄语、西班牙语、印地语、德语、越南语、巴西葡萄牙语、意大利语、葡萄牙语、泰语、乌尔都语；
• 使用小语种时上传文本编码必须使用unicode编码且设置tte=unicode（unicode即utf16小端的编码方式）或者使用UTF8的编码方式；
• 需先在控制台开启小语种发音人才可合成小语种，否则报错11200。

# 2. 兼容性说明

# 3. SDK集成包目录结构

将SDK zip包解压缩，得到如下文件：

├── Demo SparkChain的使用DEMO，DEMO中已经集成了SDK，您可以参考DEMO，集成SDK。集成前，请先测通DEMO，了解调用原理。

├── ReleaseNotes.txt SDK版本日志

├── SDK SparkChain SDK

│ └── libSparkChain.so (opens new window)

└── SparkChain 在线语音合成 Linux SDK集成文档.pdf SparkChain集成指南

# 4. SDK工程配置

# 4.1 导入SDK库

将SDK/libs文件夹、头文件文件夹include存放到项目中，并在环境变量里添加库路径；

#include "../../include/sparkchain.h"
#include "../../include/sc_tts.h"

# 4.2 配置权限

如果需要存储日志，SDK日志路径需要读写权限，缺少读写权限，日志将无法正常存储。

# 5. 接口流程调用图

# 6. SDK 初始化

在使用SparkChain 在线合成功能前，需要首先开通在线合成功能授权并获取已开通授权的应用信息（appId、apiKey、apiSecret）。SDK全局只需要初始化一次。 初始化时，开发者需要构建一个SparkChainConfig实例config，把相关的appid信息以及日志设置等传入config中，然后再通过SparkChain::init(config)方法把config实例设置到SDK中。SparkChainConfig 结构如下：

class SPARKCHAIN_API SparkChainConfig { 
    public:    
    	static SparkChainConfig* builder();    
    	virtual ~SparkChainConfig();    
    	//配置appid    
    	virtual SparkChainConfig* appID(const char* appid)         = 0;    
    	//配置apiKey    
    	virtual SparkChainConfig* apiKey(const char* apiKey)       = 0;    
    	//配置apiSecret    
    	virtual SparkChainConfig* apiSecret(const char* apiSecret) = 0;    
    	//配置用户自定义标识    
    	virtual SparkChainConfig* uid(const char* uid)             = 0;    
    	//配置SDK工作路径    
    	virtual SparkChainConfig* workDir(const char* workDir)     = 0;    
    	//配置日志等级    
    	virtual SparkChainConfig* logLevel(int logLevel )          = 0;    
    	//配置日志存储路径    
    	virtual SparkChainConfig* logPath(const char* logPath)     = 0; 
}; 

初始化参数说明：

初始化返回值：0：初始化成功，非0：初始化失败，请根据具体返回值参考错误码章节查询原因。

具体示例如下：

SparkChainConfig* config = SparkChainConfig::builder(); 
config->appID("$appId")      
    ->apiKey("$apiKey")      
    ->apiSecret("$apiSecret");//从平台获取的授权appid，apikey,apisecrety 
int ret = SparkChain::init(config);

# 7. 在线语音合成初始化

在使用在线语音合成功能前，需先通过其构造方法OnlineTTS()方法构建其实例，然后用该实例调用相应的方法去设置转写参数。

在线语音合成构造方法如下：

class SPARKCHAIN_API OnlineTTS : public TTS {
public:
    explicit OnlineTTS(string vcn);
    ~OnlineTTS();
};

构造方法参数说明：

具体示例如下：

OnlineTTS tts("xiaoyan");

# 8. 功能参数配置

SDK支持用户根据自身需求，通过构建的OnlineTTS实例访问相关方法配置合成参数。具体方法说明如下：

具体配置示例如下：

tts.aue("raw");
tts.bgs(0);//合成音频的背景音 0:无背景音（默认值） 1:有背景音
...
tts.speed(50);//语速
tts.pitch(50);//语调
tts.volume(50);//音量

# 9. 注册结果监听回调

在线语音合成运行结果通过TTSCallbacks异步返回，接口定义如下：

class SPARKCHAIN_API TTSCallbacks {
    public:
    virtual void onResult(TTSResult * result, void * usrTag = nullptr) = 0;
    virtual void onError(TTSError * error, void * usrTag = nullptr) = 0;
};

TTSCallbacks数据结构说明：

• onResult为超拟人合成音频回调方法，参数说明如下：

  参数	类型	说明
  result	TTSResult *	在线合成结果实例
  usrTag	void*	用户自定义标识

• TTSResult结构说明：

  方法	说明
  data()	⾳频数据，最⼩尺⼨:0B, 最⼤尺⼨:10485760B
  len()	音频数据长度
  status()	数据状态，0:开始, 1:开始, 2:结束
  ced()	流式音频数据的进度尾端点
  sid()	本次会话的id

• onError为超拟人合成错误回调，参数说明如下：

  参数	类型	说明
  error	TTSError *	错误信息结果实例
  usrTag	void *	用户自定义标识

• TTSError结果说明：

  方法	说明
  code()	错误码ID，具体参考错误码章节。
  errMsg()	错误信息
  sid()	本次会话的id

具体示例如下：

class onlineTTSCallbacks : public TTSCallbacks {
    void onResult(TTSResult * result,void * usrTag) override {
        const char * data = result->data();//音频数据
        int len           = result->len();//音频数据长度
        int status        = result->status();//数据状态
        string ced        = result->ced();//进度
        string sid        = result->sid();//sid  
    }

    void onError(TTSError * error, void * usrTag) override {        
        int errCode   = error->code();//错误码
        string errMsg = error->errMsg();//错误信息
        string sid    = error->sid();//sid
    }    
};
onlineTTSCallbacks cbs{};
tts.registerCallbacks(&cbs);

# 10. 请求调用

开发者注册完监听回调后，可通过tts.aRun()方法进行请求调用。请求调用接口如下：

class SPARKCHAIN_API TTS {
public: 
    virtual int arun(const string & text, void * usrTag = nullptr);
}

aRun方法结构说明：

具体示例如下：

String text = "技术支持跑的快,全靠大佬们带,受着老板们和研发大佬熏陶,技术支持也不会掉队的。"
tts.aRun(text);

# 11. 停止合成

如果开发者不需要此次合成结果，可以通过调用stop()方法结束本次合成，然后重新进行下一次交互。具体调用如下：

tts.stop();

如果不需要继续使用SDK，需要执行逆初始化释放资源。逆初始化执行步骤参考第12节。

# 12. 逆初始化

当SDK需要完整退出时，需调用逆初始化方法释放资源，示例代码如下：

SparkChain::unInit(); //SDK逆初始化

# 13. SDK API介绍

# 13.1 SparkChainConfig API

# 13.2 SparkChain API

# 13.3 OnlineTTS API

# 13.4 TTSResult API

# 13.5 TTSError API

# 14. 错误码

错误码包含SDK错误码和云端错误码。

# 14.1 SDK错误码

# 14.2 部分云端错误码

备注：如出现下述列表中没有的错误码，可到 这里 (opens new window) 查询。