# 1. 超拟人合成简介

SparkChain支持用户把一段文本送入指定的接口，获取该文本的超拟人合成音频。超拟人相比常规的合成能力，合成效果更好！同时在合成中，利用大模型生成一些拟声词，使合成的音频更加拟人化更加真实。

# 2. 兼容性说明

# 3. 授权说明

超拟人合成按照调用次数进行授权。

# 4. SDK集成包目录结构

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

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

├── ReleaseNotes.txt SDK版本日志

├── SDK SparkChain SDK

│ └── SparkChain.framework

└── SparkChain LLM iOS SDK集成文档.pdf SparkChain集成指南

# 5. SDK工程配置

# 5.1 导入SDK库

SparkChain iOS SDK 核心代码库由SparkChain.framework组成。在引入工程中时，在工程的General的frameworks,Libraries,and Embedded Content 中使用Embedded & sign

示例如下：

# 5.2 设置BitCode

SparkChain iOS SDK暂不支持Bitcode，Xcode 7、Xcode 8默认开启了Bitcode，而Bitcode 需要工程依赖的所有类库同时支持，可关闭此设置，只需在Targets - Build Settings 中搜索Bitcode 即可，找到相应选项，设置为NO。

# 6. 接口流程调用图

# 7. SDK初始化

**在使用SDK功能前，需要首先开通星火大模型授权并获取已开通授权的应用信息（appId、apiKey、apiSecret）。SDK全局只需要初始化一次。**初始化时，开发者需要构建一个SparkChainConfig实例config，把相关的appid信息以及日志设置等传入config中，然后通过[SparkChain.getInst init:config]方法把config实例设置到SDK中。具体初始化示例如下：

//配置应用信息
SparkChainConfig * config = [[SparkChainConfig alloc] init];
config.appID("appID")
     .apiKey("apiKey")
     .apiSecret("apiSecret");
int ret = [SparkChain.getInst init:config];
NSLog("初始化结果 ret = %d",ret);

初始化参数说明：

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

# 8. 超拟人初始化

在使用超拟人功能前，需先通过其构造方法PersonateTTS 类构建其实例，然后用该实例调用相应的方法去设置合成参数。

超拟人构造方法如下：

@interface PersonateTTS : TTS
- (instancetype)initWithVcn:(NSString *)vcn
@end

构造方法参数说明：

具体示例如下：

PersonateTTS * tts = [[PersonateTTS alloc] initWithVcn:@"x4_lingfeizhe_oral"];

# 9. 配置参数

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

具体配置示例如下：

tts.vcn = @"x4_lingfeizhe_oral";
tts.speed = 50;
tts.pitch = 50;
tts.volume = 50;
...
tts.sparkAssist = true

# 10. 注册结果监听回调

超拟人运行结果通过监听回调异步返回，监听回调如下：

protocol TTSCallbacks <NSObject>
- (void)tts:(TTS *)tts onResult:(TTSResult *)result usrContext:(id)context;
- (void)tts:(TTS *)tts onError:(TTSError *)error usrContext:(id)context;
@end

TTSCallbacks数据结构说明：

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

• TTSResult结构说明：

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

• TTSError结果说明：

具体示例如下：

tts.cbs = self; //设置代理
- (void)tts:(nonnull TTS *)tts onResult:(nonnull TTSResult *)result usrContext:(nonnull id)context {
     int seq = result.seq;//数据序号
     NSData *data = result.data;//音频数据
     NSString *ced = result.ced;//进度
     NSString *pybuf = result.pybuf;//拼音结果
     NSString *version = result.version;//引擎版本号
     int status = result.status;//数据状态
     NSString *sid = result.sid;//sid
}
- (void)tts:(nonnull TTS *)tts onError:(nonnull TTSError *)error usrContext:(nonnull id)context {
     int code = error.code;//错误码
     NSString *errMsg = error.errMsg;//错误信息
     NSString *sid = error.sid;//sid
}

# 11. 请求调用

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

@interface TTS : NSObject
- (void)arun:(NSString *)text;
- (void)arun:(NSString *)text userInfo:(id)userInfo;
@end

aRun方法结构说明：

具体示例如下：

NSString *text = "从未见过开得这样盛的藤萝，只见一片辉煌的淡紫色，像一条瀑布，从空中垂下，不见其发端。"
[tts arun:text];
//带用户自定义标识调用方式示例：
//int usrTag = 1;
//[tts arun:text userInfo:usrTag];

# 12. 停止合成

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

[tts stop];

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

# 13. 逆初始化

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

[[SparkChain getInst] unInit];

# 14. SDK API介绍

# 14.1 SparkChainConfig API

# 14.2 SparkChain API

# 14.3 PersonateTTS API

# 14.4 PersonateTTS TTSResult API

# 14.5 PersonateTTS TTSError API

# 15. 错误码

错误码包含SDK错误码和超拟人云端错误码。

# 15.1 SDK错误码

# 15.2 超拟人云端错误码