# SparkChain 在线翻译 Android SDK集成文档

# 1. 在线翻译简介

在线翻译集成了三种翻译能力，具体如下：

# 2. 兼容性说明

# 3. SDK集成包目录结构

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

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

├── ReleaseNotes.txt SDK版本日志

├── SDK SparkChain SDK

│ └── SparkChain.aar

└── SparkChain 在线翻译 Android SDK集成文档.pdf SparkChain集成指南

# 4. SDK工程配置

# 4.1 导入SDK库

复制SparkChain.aar到项目的libs目录下，然后在主Module的build.gradle文件中，增加如下配置：

implementation files('libs/SparkChain.aar')

# 4.2 配置权限

外部使用时需要配置以下权限：

如果部分权限不需要，可通过如下配置去除，去除示例如下：

Android 10.0（API 29）及以上版本需要在application中做如下配置
<application android:requestLegacyExternalStorage="true"/>

# 4.3 混淆配置

SparkChain SDK 已做过混淆，如果您项目中也使用了混淆，请在 proguard-rules.pro文件中添加如下配置保持SparkChain SDK 不再被混淆。

-keep class com.iflytek.sparkchain.** {*;} 
-keep class com.iflytek.sparkchain.**

# 5. 接口流程调用图

# 6. SDK 初始化

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

//配置应用信息 
SparkChainConfig config =  SparkChainConfig.builder()    
    .appID("$appId")       
    .apiKey("$apiKey")    
    .apiSecret("$apiSecret"); 
int ret = SparkChain.getInst().init(getApplicationContext(), config); 

初始化参数说明：

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

# 7. 在线翻译初始化

在使用在线翻译功能前，需先通过其构造方法ITS()方法构建其实例，然后用该实例调用相应的方法去设置翻译参数。

在线翻译构造方法如下：

public class ITS{
    public ITS(String fromlanguage, String tolanguage,TransType type) {        
        ...   
    }    
    
    public ITS(TransType type) {        
        ...  
    }    
    
    public ITS() {       
        ...
    }
}

构造方法参数说明：

具体示例如下：

ITS its = new ITS("cn", "en", TransType.ITRANS);

# 8. 功能参数配置

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

具体配置示例如下：

its.fromlanguage("cn");
its.tolanguage("en");

# 9. 注册结果监听回调

在线翻译运行结果通过ITSCallbacks异步返回，接口定义如下：

public interface ITSCallbacks {
    void onResult(ITS.ITSResult result, Object usrTag);

    void onError(ITS.ITSError error, Object usrTag);
}

ITSCallbacks数据结构说明：

• onResult为在线翻译结果回调方法，参数说明如下：

  参数	类型	说明
  result	ITS.ITSResult	翻译结果实例
  usrTag	Object	用户自定义标识

• ITS.ITSResult结构说明：

  方法	返回值类型	说明
  getTransResult().getSrc()	String	翻译的源文本
  getTransResult().getDst()	String	翻译结果
  getStatus()	int	数据状态： 3：once(一次性)
  getSid()	String	本次交互的sid
  getFrom()	String	源语种
  getTo()	String	目标语种

• onError为在线翻译错误回调，参数说明如下：

  参数	类型	说明
  error	ITS.ITSError	错误信息结果实例
  usrTag	Object	用户自定义标识

• ITS.ITSError结构说明：

  方法	返回值类型	说明
  getCode()	int	错误码
  getErrMsg()	String	错误信息
  getSid()	String	交互的Sid

具体示例如下：

ITSCallbacks miTransCallback = new ITSCallbacks() {
    @Override
    public void onResult(ITS.ITSResult itsResult, Object o) {
        String srcText = itsResult.getTransResult().getSrc(); //翻译的源文本
        String dstText = itsResult.getTransResult().getDst(); //翻译结果
        int status     = itsResult.getStatus();               //翻译结果状态
        String from    = itsResult.getFrom();                 //源语种
        String to      = itsResult.getTo();                   //目标语种
        String sid     = itsResult.getSid();                  //本次交互的SID
    }

    @Override
    public void onError(ITS.ITSError itsError, Object o) {
        int code   = itsError.getCode();    //错误码
        String msg = itsError.getErrMsg();  //错误信息
        String sid = itsError.getSid();     //交互sid
    }
};
its.registerCallbacks(miTransCallback);

# 10. 请求调用

开发者注册完监听回调后，可通过its.arun()方法开启会话。请求调用接口如下：

public class ITS {
    public int arun(String txt,Object usrTag) {      
        ...
    }
}

start方法结构说明：

具体示例如下：

int ret = its.arun("今天天气很好","12345");

# 11. 语种列表

使用不同类型的翻译，其中包含的翻译语种类型并不相同，具体如下：

注意：使用其他语种前，需要确保已开通相关语种的授权！

# 11.1 讯飞翻译语种列表

# 11.2 小牛翻译语种列表

# 11.3 海外翻译语种列表

Translation between Chinese and other languages:

Translation between English and other languages：

# 12. 逆初始化

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

SparkChain.getInst().unInit();  //SDK逆初始化

# 13. SDK API介绍

# 13.1 SparkChainConfig API

# 13.2 SparkChain API

# 13.3 ITS API

# 13.4 ITSResult API

# 13.5 ITSError API

# 13.6 TransResult API

# 14. 错误码

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

# 14.1 SDK错误码