Android SDK 文档
1. 离线唤醒能力简介
该能力可满足无网络环境下在连续语音流中实时检测出关键词片段。SDK轻巧方便，无需网络流量，实时响应，可运行于Android、Linux等平台Android或嵌入式设备。 2、可用于智能终端、智能家居、家电、车机系统等服务场景。
支持多实例并发：否
协议类型：异步流式
#2.授权说明
授权方式支持【设备授权】和【应用授权】2种。
设备授权： 按照设备数和有效期授权，激活设备数达到授权量上限后，新设备将无法继续激活使用。SDK采集多个设备标识按照权重算法生成设备指纹精准标识设备，计量准确。支持所有平台。
应用授权： 对指定应用授权，仅可在授权的应用上使用，无数量限制，可限制有效期。需提供应用唯一标识，授权能力后，应用级授权支持Android、iOS平台应用。
能力激活支持【在线激活】和【离线激活】2种方式。在能力首次使用时，需要先激活后方可使用。激活时会获取授权license缓存到设备内部存储中。
在线激活: 在首次使用时，需要将设备联网，SDK初始化时获取授权license激活。设备激活后，即可在无网环境下使用。如果有恢复出厂设置或清空应用缓存等操作，将license清除后，能力将无法正常使用，将设备联网重启应用即可恢复。适用于设备可联网场景，激活过程简单。
离线激活: （购买装机量达到10000台后，可以通过工单申请离线激活license文件）将申请的批量激活license文件内置到设备中，在初始化时指定离线激活文件路径，SDK初始化时会自动读取解析本地离线激活文件激活设备，设备激活后，离线激活文件会自动删除。如果有恢复出厂设置或清空应用缓存等操作，将license清除后，能力将无法正常使用，需通过离线激活文件重新激活。适用于设备不可联网或无网场景。
#3. 兼容机型
| 类别 | 兼容范围 |
|---|---|
| 系统 | 支持Android 5.0 ~ Android 13 版本，鸿蒙系统未做系统兼容性验证 |
| 机型 | 上市的Android手机和平板、及符合具体能力性能要求的Android系统扫描笔、手表等设备 |
| 网络 | 对网络无要求，设备具备联网条件，可使用在线激活方式，首次使用需要连接网络。若设备不能联网，需要使用离线激活方式 |
| 开发环境 | 建议使用 Android Studio 进行开发 |
#4. SDK包组成
DEMO 中已经集成了SDK， 您可以参考DEMO，集成SDK。集成前，请先测通DEMO，了解调用原理。如果您自己代码过于复杂，可以使用一个helloworld项目了解集成过程。
将SDK zip包解压缩，得到如下文件：
- Demo //能力SDK Demo、SDK使用说明readme.txt，示例能力调用
- SDK //能力SDK，导入SDK库时使用
- resource //能力对应模型资源，多能力组合时，resource文件夹中包含多个子文件夹
- 测试报告 //SDK 测试报告
- ReleaseNotes.txt //SDK版本日志
#5. 接口调用流程
#6. 快速集成指南
#6.1 导入SDK库
复制 AIKit.aar 到项目的 libs 目录下，然后在项目的 build.gradle 文件中，增加如下配置：
dependencies {
// 已忽略无关代码
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation files('libs/AIKit.aar')
}
#6.2 配置权限
AIKit SDK中使用了如下权限：
| 权限 | 使用说明 |
|---|---|
| INTERNET | SDK需要访问网络获取、更新授权 |
| READ_PHONE_STATE | 获取设备IMEI用于精准授权，IMEI加密存储，不会存储明文 |
| WRITE_EXTERNAL_STORAGE | SDK写本地日志需要用到该权限 |
| READ_EXTERNAL_STORAGE | SDK加载本地模型资源文件需要该权限 |
| MOUNT_UNMOUNT_FILESYSTEMS | Android 11以上需要该权限 |
| READ_PRIVILEGED_PHONE_STATE | Android 10 以后新增权限，同 READ_PHONE_STATE |
| MANAGE_EXTERNAL_STORAGE | 获取所有文件的访问权限（Android 11以上需要该权限） |
| READ_PHONE_NUMBERS | 获取设备IMEI用于精准授权，IMEI加密存储，不会存储明文（Android 11及以上获取） |
SDK中已配置如下权限，如部分权限不需要，可通过如下配置去除
<!-- 移除SDK非必须权限示例 -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" tools:node="remove" />
<uses-permission android:name="android.permission.READ_PRIVILEGED_PHONE_STATE" tools:node="remove" />
Android 11（API 30）及以上版本需要增加以下权限
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_PHONE_NUMBERS" />
Android 10.0（API 29）及以上版本需要在application中做如下配置
<application android:requestLegacyExternalStorage="true"/>
#6.3 资源导入
复制resource文件夹中文资源到应用的工作目录，即为SDK初始化中的workDir。
#6.4 SDK初始化
在使用能力前，需要首先初始化SDK，使用SDK提供的单能力或组合能力时，SDK均只需要初始化一次。
// 初始化参数构建
AiHelper.Params params = AiHelper.Params.builder()
.appId(appID)
.apiKey(apiKey)
.apiSecret(apiSecret)
.ability("e867a88f2")
.workDir("/sdcard/iflytek/aikit")//SDK工作路径，这里为绝对路径，此处仅为示例
.build();
// 初始化
AiHelper.getInst().init(this, params);
如上代码所示，SDK初始化参数中appId、apiKey、apiSecret 和workDir为必填项。
以下是这些初始化参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appID | String | 是 | 应用ID |
| apiKey | String | 是 | 离线引擎托管平台创建应用后，生成的唯一应用标识 |
| apiSecret | String | 是 | 离线引擎托管平台创建应用后，生成的唯一应用秘钥 |
| workDir | String | 是 | SDK工作目录。默认读取能力资源、写SDK日志在此路径下 |
| licenseFile | String | 否 | （购买装机量达到10000台后，可以通过工单申请离线激活license文件）离线授权license文件绝对路径，SDK离线激活方式，需要从离线引擎托管平台申请的离线授权license文件，放入设备指定路径中（可放入至SDK工作路径下），即licenseFile参数即为离线激活文件的绝对工作路径。 |
| customDeviceId | String | 否 | 用户自定义设备指纹块，默认为空，设置后会成为设备指纹的一部分，建议设置长度低于256 |
| authType | int | 否 | 离线授权类型（0或1），0-->(默认)设备级授权（DEVICE）和 1-->应用级授权（APP） |
| authInterval | int | 否 | 在线授权校验间隔时长，默认为300s，可自定义设置，最短为60s，单位秒 |
| resDir | String | 否 | 指定资源读取路径，不设置默认从workDir读取 |
| ability | String | 是 | SDK v2.2.13+版本新增接口，传入需要用到的一个或多个能力ID，格式为"xxxx1;xxxx2"，多个能力ID中间用 英文分号 隔开，如果注册的能力非空，SDK将对传入的能力ID授权； |
#6.5 注册监听代理
SDK 初始化状态及能力结果可通过registerListener注册监听，在回调方法中获取，SDK的状态和结果回调只支持一个监听器，多次设置会覆盖。 可为每个能力指定一个结果回调监听。注册方法及回调接口说明如下：
AiHelper.getInst().registerListener(coreListener);// 注册SDK 初始化状态监听 AiHelper.getInst().registerListener("e867a88f2", aiRespListener);// 注册能力结果监听
#6.5.1 授权状态回调
授权状态回调 AuthListener 实现示例如下：
private AuthListener coreListener = new AuthListener() {
@Override
public void onAuthStateChange(final ErrType type, final int code) {
Log.i(TAG, "core listener code:" + code);
switch (type) {
case AUTH:
Log.i(TAG,"SDK状态：授权结果码" + code);
break;
case HTTP:
Log.i(TAG,"SDK状态：HTTP认证结果" + code);
break;
default:
Log.i(TAG,"SDK状态：其他错误");
}
}
};
SDK仅需要初始化一次，首次初始化成功后，再次初始化不会调用该方法。若初始化失败，再次调用初始化，会再次回调。
onAuthStateChange：
| 参数 | 类型 | 说明 |
|---|---|---|
| type | ErrType | SDK错误类型，0 表示授权错误，1 表示 http 请求错误 |
| code | int | 错误码，0 表示正常 |
#6.5.2 能力计算进度、结果回调
能力结果及计算进度状态回调示例代码如下：
/**
* 能力监听回调
*/
private AiListener aiRespListener = new AiListener() {
@Override
public void onResult(int handleID, List<AiResponse> outputData, Object usrContext) {
if (null != outputData && outputData.size() > 0) {
for (int i = 0; i < outputData.size(); i++) {
byte[] bytes = outputData.get(i).getValue();
if (bytes == null) {
continue;
}
String key = outputData.get(i).getKey();
//获取到结果的key及value，可根据业务保存存储结果或其他处理
}
}
}
@Override
public void onEvent(int handleID, int event, List<AiResponse> eventData, Object usrContext);
}
@Override
public void onError(int handleID, int err, String msg, Object usrContext);
}
};
onResult：能力执行结果返回
| 参数 | 类型 | 说明 |
|---|---|---|
| handleID | int | 会话ID |
| outputData | List | 能力执行结果 |
| usrContext | Object | 用户自定义标识 |
onEvent：事件回调
| 参数 | 类型 | 说明 |
|---|---|---|
| handleID | int | 会话ID |
| event | int | 事件状态，0：未知错误；1：开始；2：结束；3：超时；4：进行中 |
| eventData | List | 事件消息数据 |
| usrContext | Object | 用户自定义标识 |
onError：错误通知，能力执行终止
| 参数 | 类型 | 说明 |
|---|---|---|
| handleID | int | 会话ID |
| err | int | 错误码 |
| msg | String | 错误相关标识 |
| usrContext | Object | 用户自定义标识 |
能力输出结果 AiResponse 说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| key | String | 输出数据名称 |
| type | enum | 输出数据类型，1=文本 |
| value | byte[] | 字节数组类型输出数据 |
| varType | enum | 输出数据参数类型，0=字节数组 |
| len | int | 输出数据长度 |
#6.6 个性化数据接口
个性化数据一般为用户自定义配置文件，用户根据业务需求配置个性化数据，SDK 加载个性化数据示例代码如下：
int ret = 0;
AIRequest.Builder customBuilder = AIRequest.builder();
//key：数据标识 value： 唤醒词配置文件 index： 数据索引,用户可自定义设置
customBuilder.customText("key_word", "/sdcard/iflytek/ivw/keyword.txt", 0);
ret = AiHelper.getInst().loadData("e867a88f2", customBuilder.build());
if (ret != 0) {
Log.e(TAG, "loadData 失败：" + ret);
}
//指定要使用的个性化数据集合，未调用，则默认使用所有loadData加载的数据
int[] indexs = {0};
/*
* indexs 个性化数据索引数组
*/
AiHelper.getInst().specifyDataSet("e867a88f2", "key_word", indexs);
if (ret != 0) {
Log.e(TAG, "specifyDataSet 失败：" + ret);
}
个性化数据参数说明
数据段名称：key_word 数据类型：文本
loadData 方法参数说明：设置个性化数据
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| abilityId | String | 是 | 能力标识ID |
| request | AiRequest | 是 | 个性化数据构造器 |
specifyDataSet 方法参数说明：指定要使用的个性化数据集合，未调用，则默认使用所有loadData加载的数据
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| abilityId | String | 是 | 能力标识ID |
| key | String | 是 | 个性化资源key |
| indexs | AiRequest | 是 | 个性化资源索引 |
preProcess方法参数说明：为避免个性化数据重复加载耗时，可调用该预处理方法，对原始个性化资源进行预处理，再次调用能力时，则引擎会自 动加载预处理后的资源。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| abilityId | String | 是 | 能力标识ID |
| request | AiRequest | 是 | 个性化资源key |
#6.7 能力调用接口
#6.7.1 创建会话start
通过 start 方法开启会话，传入当前能力所需要指定的参数。示例代码如下：
AiRequest.Builder paramBuilder = AiRequest.builder();
//paramBuilder.param("wdec_param_nCmThreshold", $paramValue);
//paramBuilder.param("gramLoad", false);
AiHandle handle = AiHelper.getInst().start("e867a88f2",paramBuilder.build(),null);
if (!handle.isSuccess()) {
Log.e(TAG, "ERROR::START | handle code:" + handle.getCode());
return;
}
功能参数
| 功能标识 | 功能描述 | 数据类型 | 取值范围 | 必填 | 默认值 |
|---|---|---|---|---|---|
| wdec_param_nCmThreshold | 门限值 | string | 最小长度:0, 最大长度:1024 | 否 | |
| gramLoad | 更新自定义唤醒词 | bool | true:true, false:false | 否 | false |
- 唤醒词门限值
唤醒词门限值就是唤醒这个词的得分需要达到的阈值，如果你设置了这个门限值是1000，那么你唤醒得分必须要超过1000才能被唤醒
门限值设置只能针对每个唤醒词设置，可以在代码设置，调用wdec_param_nCmThreshold，格式如下：0 1:100 => 0 为第一个唤醒词文件 1 为第二个唤醒词 100 为门限值， 多个唤醒词情况下用 | 分割，如'0 0:100|0 1:200'
门限值也可以在唤醒词文件里设置，格式如下（唤醒词文件格式为UTF-8编码）：
科大讯飞;nCM:300;
你好小迪;nCM:400;
小白小白;nCM:600; - 字门限
主要作用：降低发音相近的唤醒词之间的串扰
副作用：对于设置了字门限的唤醒词的唤醒效果会略微有一点降低
例如：
唤醒词“打开电灯”和“关闭电灯”，如果同时设置了这两个唤醒词，且两个词之间的串扰比较多（音频内容是“打开电灯”，但是唤醒了“关闭电灯”），字门限就可以将这种唤醒词之间的串扰降低。 - 唤醒引擎的原理是给一个词的每个字打分（字得分），并且给每个词做一个综合打分（词得分），字得分没有过字门限或者词得分没有过词门限都会导致不会唤醒。造成上述两个串扰的原因是两个词里面有“电灯”两个字是一样的，就会导致两个词的得分大概率相差不大。
例如：音频内容是“打开电灯”的时候，两个唤醒词的字得分和词得分就有可能是下述情况（词得分不是字得分的简单平均）
打 开 电 灯 词得分
800 800 800 800 800
关 闭 电 灯 词得分
500 600 1000 1000 900
对于不同的字，音频内容是“打开”时，那大概率“打开”这两个字的得分会比“关闭”两个字的得分高，“电灯”这两个字的得分会因为上下文不同而略有不同，所以根据前两个字的得分差距来将两个词的串扰现象降低，即为“打开”和“关闭”这四个字的字门限
字门限值的设置没有统一的固定值，具体要根据用户实际场景设置
AiRequest.Builder
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | String | 是 | 功能参数名称 |
| value | String/int/double/bool | 是 | 功能参数取值 |
start方法参数说明
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ability | String | 是 | 能力标识ID |
| request | AiRequest | 是 | 能力参数，可使用AiRequest.Builder快捷构建 |
| usrContext | Object | 否 | 用户自定义标识 |
返回：AiHandle
AiHandle对象内部提供isSucess方法，用于判断会话是否启动成功
0=成功，其他=错误
#6.7.2 写入数据
通过调用 write 方法送入能力输入数据。 write方法参数说明
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| input | AiRequest | 是 | 能力输入，可使用AiRequest.Builder快捷构建 |
| handle | AiHandle | 是 | 会话的handle对象 |
返回: 0=成功，其他=错误
送入数据实现代码如下：
AiRequest.Builder dataBuilder = AiRequest.builder();
//输入音频数据
AiAudio.Holder wavData = AiAudio
.get("wav")//输入数据key
.encoding(AiAudio.ENCODING_DEFAULT)//设置音频类型
.data(part);//part为 byte[]类型输入数据
wavData.status(AiStatus.BEGIN); //送入数据的状态，首帧数据、尾帧数据、中间数据，根据送入数据的状态传入对应的值，取值对应AiStatus.BEGIN、AiStatus.END、AiStatus.CONTINUE
dataBuilder.payload(wavData.valid());
int ret = AiHelper.getInst().write(dataBuilder.build(), aiHandle);
//ret 值为0 写入成功；非0失败，请参照文档中错误码部分排查
if (ret != 0) {
String error = "start write failed" + ret;
Log.e(TAG, error);
}
能力输入数据
数据段名称：wav 数据类型：音频
以下是音频输入参数含义说明：
| 字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
|---|---|---|---|---|---|---|
| encoding | 音频编码 | string | pcm | pcm | 取值范围可枚举 | 否 |
| sample_rate | 采样率 | int | 16000 | 16000 | 音频采样率，可枚举 | 否 |
| channels | 声道数 | int | 1 | 1 | 声道数，可枚举 | 否 |
| bit_depth | 位深 | int | 16 | 16 | 单位bit，可枚举 | 否 |
| data | 音频数据 | string | 音频大小：0-10M | 否 | ||
| frame_size | 帧大小 | int | 最小值:320, 最大值:320 | 320 | 帧大小，默认320 | 否 |
#6.7.3 获取能力输出结果
结果将通过 AIListener 回调返回，AIListener 接口实现可参考6.5.2 节；能力结果数据格式及含义如下：
能力输出数据
数据段名称：rlt 数据类型：文本
以下是文本输出参数含义说明：
| 字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
|---|---|---|---|---|---|---|
| encoding | 文本编码 | string | utf8, gb2312 | utf8 | 取值范围可枚举 | 否 |
| compress | 文本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
| format | 文本格式 | string | plain, json, xml | json | 取值范围可枚举 | 否 |
| data | 文本数据 | string | 文本大小：0-1M | 否 |
输出结果示例：
{"rlt":[{"sid":"undefine","istart":58,"iresid":0,"iresIndex":0,"iduration":131,"nfillerscore":79068,"nkeywordscore":190525,"ncm_keyword":1763,"ncm_filler":0,"ncm":1763,"ncmThresh":800,"decConfidence":0.000000,"keyword":"开启","nDelayFrame":0,"wakeUpType":0}]}
| 结果json参数 | 字段含义 |
|---|---|
| sid | 本次会话唤醒的任务id |
| istart | 唤醒词开始时间（单位是10ms） |
| iresid | 唤醒词序号 |
| iresIndex | 无需关注 |
| iduration | 唤醒词持续时间（单位是10ms，例如78表示时间长度是 780ms） |
| nfillerscore | - |
| nkeywordscore | - |
| ncm_keyword | 唤醒词keyword得分 |
| ncm_filler | filler得分 |
| ncm | 唤醒词得分 |
| ncmThresh | 唤醒词门限 |
| decConfidence | - |
| keyword | 识别到的唤醒词 |
| nDelayFrame | - |
| wakeUpType | 唤醒类型 |
pl: “ - ” 意味着该参数不重要，无需关注。
#6.7.4 结束会话
int ret = AiHelper.getInst().end(aiHandle);
if (ret != 0) {
String error = "end failed" + ret;
Log.e(TAG, error);
}
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| handle | AiHandle | 是 | 会话的handle对象 |
返回：0=成功，其他=错误
#6.8 SDK逆初始化
当不再使用能力时，需调用逆初始化方法释放资源，示例代码如下：
AiHelper.getInst().unInit();
#6.9 导入资源验证
复制resource文件夹下文资源到SDK的工作目录(示例代码工作路径为：”/sdcard/iflytek/aikit“)下，即为SDK初始化中的workDir。资源导入完成后，至此已完成合成能力接入，可运行测试合成效果。
#7. 高级功能
#7.1 日志配置
AiHelper.getInst().setLogInfo(LogLvl.DEBUG, 1, "/sdcard/iflytek/aikit");
日志配置参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| LogLvl | enum | 日志级别枚举值如下: DEBUG, INFO, WARN, ERROR, FATAL, OFF |
| LogMode | int | 日志模式（stadout:0 logcat:1 file:2） |
| LogPath | String | 日志路径（路径可根据实际需求进行修改） |
#7.2 参数配置
可通过 setConfig 方法实现license缓存路径、日志文件上限等配置，使用举例如下：
AiHelper.getInst().setConfig("licenseStoragePath","/sdcard/iflytek/aikit");
可配置参数
| 参数 | 类型 | 说明 |
|---|---|---|
| licenseStoragePath | String | 授权文件存储路径,Android平台默认保存在 SharePreference下，可通过该配置设置保存在其他路径下。 |
| logMaxSize | String | 日志文件上限 |
#7.3 个性化数据卸载
已加载的个性化数据，如果不在使用或者需要替换，需要卸载已加载的个性化资源，示例代码如下：
AiHelper.getInst().unLoadData("e867a88f2", "key_word", indexs);
可配置参数
| 参数 | 类型 | 说明 |
|---|---|---|
| ability | String | 能力id |
| key_word | String | 个性化数据唯一标识 |
| index | String | 个性化数据索引 |
个性化数据参数说明
数据段名称：key_word 数据类型：文本
#7.4 资源从asset读取
对于模型资源比较小的能力，如果想将模型资源打包到APK或aar 中，可在项目主module 下asset 目录下创建 aikit_resources 目录，将模型资源放置在 aikit_resources文件夹下即可。
#8. Android平台常见问题
- SDK 错误码返回18700，错误日志出现 “online license activate ret:18700 ；auth request failed:2007,未发现SDK” 如何解决?
appid 未授权该SDK 能力，请申请授权后使用该能力。
- SDK 错误码返回18714，错误日志出现 “[{"message":"HMAC signature cannot be verified: fail to retrieve credential"}]” 如何解决?
appid、apiKey、apiSecret 配置有误，请检查配置。
- SDK 初始化返回 18007，错误日志出现"httpPost failed! 401{"message":"HMAC signature does not match"}；online license activate ret:18714；AEE_Init ret 18007"，如何解决？
apiKey 或 apiSecret 有误，请检查apiKey、apiSecret 的值是否正确，并替换为正确的值。
- SDK 初始化时返回18704，错误日志出现“auth request failed:2003,未发现应用”；“AEE_Init ret 18704,”，如何解决？
appid 不存在或appid 未授权，请使用正确的 appid。
- SDK 初始化时返回18400，错误日志出现 “workDir does not have write permission sdcard/xxxx/xxx”，“AEE_Init ret 18400”
SDK 初始化时设置的SDK工作路径即“workDir” 无读写权限，请确保SDK 初始化时，SDK工作路径具有读写权限。
- SDK 在初始化引擎时，返回 18601，错误日志出现 “AEE_EngineInit:e09712bcb11 ret 18601”；“ability: xxxxxxx not exist”，如何解决？
能力（能力id为 xxxxxx）不存在，初始化引擎时传入的能力id有误，请检查能力id是否正确；或改能力未授权，请确认该能力是否已申请授权。
- 调用SDK 的start 或 AEE_Start 方法时，返回错误码 18105，错误日志出现“AEE_Start:e09712bcb ret 18105”; "cannot find dependent resource: xxxxxx",如何解决？
该错误为资源未找到，请检查是否将资源导入到了SDK的工作路径下。
- 日志中出现“AEE_Start: xxxxxxx ret 18310; AEE_Start failed:18310”错误日志如何解决？
流式接口能力，调用 AEE_Start 或 start 方法开始的会话，未调用AEE_End 或 end 方法打断或正常结束，再次调用AEE_Srart则SDK会返回18310错误，同一个能力SDK不支持并发调用，需要结束本次会话之后，才能开始下一次会话。
- 日志中出现“[ERROR]:[ getAbility]-[0474]:ability:64b9b706 not exist AEE_EngineInit: xxxxxxx ret 18601” ，错误码返回18601 错误，如何解决？
请检查确认引擎初始化及调用能力时所传能力id参数是否正确；如果能力ID无误，SDK日志中打印的 xxxxxx 能力未授权。
- 日志中出现“auth request failed:2015,无效的指纹”、“online license activate ret:18713”，SDK返回18713错误，如何解决？
应用安全等级与设备指纹不符，须申请调整appid 安全等级；
#错误码
| 错误码 | 含义 | 自查指南 |
|---|---|---|
| 18000 | 本地 license 文件不存在 | 离线激活方式，请检查离线授权文件路径下，license 文件是否存在；如果不存在，请将申请的离线授权文件放置在对应路径下； 在线激活方式下，请检查 workDir 目录下 license 文件是否存在，如果不存在，请将设备联网，重启应用。 |
| 18001/18002 /18003/18004 | 授权问题 | Linux 平台删除授权文件，将设备联网，重启应用，重新从云端获取授权文件； Android 端清除应用缓存，将设备联网，重启应用，重新从云端获取授权文件； 如仍有问题，请联系项目经理协助解决。 |
| 18005 | 授权已过期 | 能力授权已过期。 |
| 18006 | 授权时间错误，设备时间比标准时间慢 30 分钟以上 | 设备时间不准确导致，请校正设备时间为标准时间，重启应用。 |
| 18007 | 授权应用不匹配（apiKey、apiSecret） | apiKey、apiSecret配置有误，请核对项目中配置的 apiKey、apiSecret 。 |
| 18008 | 授权文件激活过期 | 非永久授权激活文件的有效期为 3天，Linux 平台删除授权文件、Android平台清除应用缓存后重启应用重新激活； 若设备无法联网，请重新申请离线激活文件，在 3 天内激活。 |
| 18010 | 离线授权激活文件指定平台与设备平台不匹配 | 批量授权激活文件不支持当前设备平台，离线批量授权文件仅只支持申请时指定的的特定平台，不可多平台混用。 |
| 18011 | 离线授权激活文件指定架构与设备 CPU 架构不匹配 | 批量授权激活文件不支持当前设备架构，离线批量授权文件仅只支持申请时制定的特定架构，不支持多架构混用。 |
| 18012 | 离线授权激活文件中包含 license 个数异常 | 离线批量激活文件异常，请检查设备中使用的离线激活文件与所申请的是否一致 |
| 18013 | 离线授权激活文件中未找到当前设备 | 批量离线授权激活文件中不包含改设备，请联网激活或申请离线授权激活文件。 |
| 18014 | 离线授权激活文件中设备指纹安全等级非法 | 离线授权文件中安全等级错误，请联系平台重新提供 |
| 18015 | 硬件授权验证失败 | - |
| 18016 | 离线授权激活文件内容非法 | 批量离线授权文件不合法，请替换正确的批量离线激活文件测试，如仍有问题，请联系项目经理协助解决。 |
| 18017 | 离线授权激活文件中协议头非法 | 批量离线授权文件不合法，请替换正确的批量离线激活文件测试，如仍有问题，请联系项目经理协助解决。 |
| 18018 | 离线授权激活文件中指纹组成项个数为0 | 未获取到有效的设备标识，例如 Android平台 Androidid 未获取到；Linux平台 MAC等未获取到。 |
| 18019 | 资源已过期 | 请联系平台技术人员解决 |
| 18100/18101/18102 | 资源错误 | 请仔细检查所用资源与平台提供的资源是否一致，可通过MD5对比，请使用提供SDK时附带的成套资源。 |
| 18103 | 资源参数不存在 |
请根据文档检查能力参数Key、Value 是否合法。 |
| 18104 | 资源路径打开失败 | 资源路径无读写权限，请确保在 SDK 初始化时以获取到读写权限，或将资源路径设置为有读写权限的路径下。 |
| 18105 | 资源加载失败，workDir 内未找到对应资源 | 请根据日志提示将所需资源导入到指定路径下 |
| 18106 | 资源卸载失败 | 请检查代码是否存在未初始化时调用 SDK uninit 方法，或多次调用 uninit 方法 |
| 18200 | 引擎鉴权失败 | 应用授权信息与SDK不对应。 1. 请尝试将设备联网后重启应用； 2. 请检查您项目中使用的SDK和平台提供的是否一致； |
| 18201 | 引擎动态加载失败 | 请检查日志中打印的引擎库是否已导入到项目中 |
| 18202 | 引擎未初始化 | 请检查调用能力前是否已初始化引擎及初始化是否成功。 |
| 18203 | 引擎不支持该接口调用 | 请参照 Demo 仔细检查方法调用是否正确 |
| 18205 | 引擎重复初始化 |
请根据文档检查引擎初始化方法是否存在重复调用，引擎初始化全局仅需初始化一次。 |
| 18206 | 引擎参数非法 | 请根据文档检查引擎初始化参数是否合法； |
| 18207 | 引擎上下文未注册 | - |
| 18300 | SDK不可用 | 请联系平台技术人员解决 |
| 18301 | SDK未初始化 | 在使用能力前请先初始化 SDK，如果有调用 uninit 方法，再次使用能力时需要重新初始化。 |
| 18302 | SDK初始化失败 | 请根据CoreListener回调中返回的错误码参考此文档做对应检查 |
| 18303 | SDK 已经初始化 | 重复初始化导致，使用能力时，SDK 只需要初始化一次，请检查 SDK 初始化逻辑是否存在多次初始化。 |
| 18304 | 不合法参数 | 请参考demo及协议文件仔细检查所传参数是否正确；若确认无误，请联网后重启应用后重试 |
| 18305/18306 | 会话不存在或已销毁 | 1. 请检查 start 方法调用是否返回成功； 2. 请排查代码是否在调用 end 方法结束会话后又调用了 write 或read 方法。 3. 请确保 end 方法在能力执行完毕后调用，能力执行结果会在 onEvent 中回调。 |
| 18307 | 会话重复终止 | 该错误一般为重复调用 end 方法导致， 请仔细检查代码是否有重复调用 end 方法 |
| 18308 | 超时错误 | 请检查网络是否正常连接 |
| 18309 | SDK正在初始化中 | 请联系平台技术人员解决 |
| 18310 | 会话重复开启 | start 、end方法需成对调用，请仔细检查代码逻辑是否存在调用start 后未调用end结束会话，又再次调用start 情况出现 |
| 18400 | 工作目录无写权限 | 在设置 workDir 时，请确保该工作路径有读写权限。若无法设置读写权限，请修改为有读写权限的工作路径。 |
| 18401 | 未获取到设备标识 | 没有获取到组成设备指纹所必须的组成项，请确认 mac、AndroidID、SN 等是否能获取到，请根据授权安全等级确保能获取对应数量的设备标识。 |
| 18402 | 文件打开失败 | 请检查 日志中所打印的文件是否存在，以及对应路径下是否有读权限。 |
| 18404 | 设备指纹比较失败 | 设备指纹组成项发生变化导致，获取到的设备指纹与缓存的设备指纹不一致，请将设备联网后重启应用重试。 |
| 18405 | 工作目录不存在 | 请检查资源文件文件夹是否存在 |
| 18500 | 未找到该参数 key | 请参照demo或协议文档仔细检查参数名拼写 |
| 18501 | 参数范围溢出，不满足约束条件 | 请根据协议检查调用 SDK 方法时所传参数范围，需要确保所传参数符合协议约束要求 |
| 18502 | SDK 初始化参数为空 | 请根据 SDK 集成文件检查 SDK 初始化代码，确保必填参数有值且合法 |
| 18503 | SDK 初始化参数中 appId 为空 | appId 为空值，请在 SDK 初始化时传入正确的 appId 值 |
| 18504 | SDK 初始化参数中 apiKey为空 | apiKey为空值，请在 SDK 初始化时传入正确的 apiKey值 |
| 18505 | SDK 初始化参数中 apiSecret 为空 | apiSecret 为空值，请在 SDK 初始化时传入正确的 apapiSecret 值 |
| 18506 | abilityId 参数为空 | abilityId 为空值，请检查 引擎初始化方法及调用能力方法时所传的 abilityId 是否正确 |
| 18507 | input 参数为空 | 请检查调用能力方法时 input 参数是否为空 |
| 18508 | 输入数据参数 Key 不存在 | 请根据协议文档检查输入参数的 key |
| 18509 | 必填参数缺失 | 请根据文档或demo检查参数漏传项 |
| 18510 | 输出参数缺失 | 能力输出参数缺失 |
| 18520 | 不支持的编解码类型 |
输入的编解码格式不支持 |
| 18600 | 协议中时间戳字段缺失 | 请将设备联网后重启应用 |
| 18601 | 协议中未找到该能力 ID | 请确认 SDK 初始化时所传 appId、 apiKey、apiSecret 是否正确； 若无误请删除授权文件或清空应用缓存后重启应用； 请确认所传能力 ID 是否正确； 请联系平台协助排查授权是否已过期或授权量已用完。 |
| 18602 | 协议中未找到该资源 | 请确认 SDK 初始化时所传 appId、 apiKey、apiSecret 是否正确； 请将设备联网后重新应用重试； 请确认是否已申请授权过该资源。 |
| 18603 | 协议中未找到该引擎 | 请确认 SDK 初始化时所传 appId、 apiKey、apiSecret 是否正确； 请将设备联网后重新应用重试； 请确认项目中使用SDK版本是否正确。 |
| 18606 | 协议能力接口类型不匹配 | 请根据协议检查能力接口类型是否一致，流式与非流式接口不可混用 |
| 18607 | 预置协议解析失败 | 请联系平台技术人员解决 |
| 18700 | 能力未授权 | 该SDK未授权，请联系项目经理申请授权 |
| 18701 | 网络不通 | 请检查网络连接是否正常 |
| 18702 | 网关检查不过 | 检查设备时间是否正确； 请检查 SDK 初始化时所传 apiKey、apiScrect 是否正确; |
| 18703 | 云端响应格式不对 | 请检查网络是否可以正常访问外网 |
| 18704 | 应用未注册 | 请检查appid 是否正确 |
| 18705 | 应用 ApiKey & ApiSecret 校验失败 | 请检查 apiKey、apiSecret 是否正确 |
| 18706 | 引擎不支持的平台架构 | 您所使用的能力不支持该设备平台架构，请确认申请的SDK支持的平台架构。 |
| 18707 | 授权已过期 | 如需继续使用请申请授权延期 |
| 18708 | 无可用授权 | 该能力不支持当前平台架构的设备； 2. 授权量已满 |
| 18709 | 未找到该 appid 绑定的能力 | 请检查 appId 是否正确；请确认是否已购买该能力 |
| 18710 | 未找到该 appid 绑定的资源 | 请检查 appId 是否正确；请检查是否已申请受限资源 |
| 18711 | json操作失败 | 请联系平台技术人员解决 |
| 18712 | http 404错误 | 请联系平台技术人员解决 |
| 18713 | 设备指纹安全等级不匹配 | 设备指纹安全等级不匹配，请申请申请安全等级变更 |
| 18714 | 应用信息错误 | 一般为apiKey、apiSecret值有误，请检查 appid、apiKey、apiSecret 的值是否正确。 |
| 18715 | 未找到该SDKID | 该组合能力SDK未授权，请申请授权 |
| 18716 | 未找到该组合能力集合 | 该组合能力未创建，请申请授权 |
| 18717 | SDK组合能力授权不足 | 组合能力授权量已用完，需申请追加授权 |
| 18718 | 无效授权应用签名 | 应用级授权，应用签名与授权签名不一致 |
| 18719 | 应用签名不唯一 | 应用级授权，提供的应用签名有误 |
| 18720 | 能力schema不可用 | 请联系平台技术人员解决 |
| 18721 | 未找到能力集模板 | 请联系平台技术人员解决 |
| 18722 | 能力不在模板能力集模板中 | 该能力未授权，请申请授权 |
| 18801 | 建立链接错误 | - |
| 18802 | 结果等待超时 | - |
| 18803 | 连接状态异常 | - |
最后修改时间： 1 年前