Android SDK 文档
1、简介
使用方法详见 动态修正
#2、SDK集成指南
#2.1、Demo运行步骤
下载完SDK后，解压至相应的路径，以Android Studio集成开发工具为例，测试时建议直接用真机进行测试。
#方法一（导入project方式）：
如果编译时出现“ERROR: Plugin with id 'com.android.application' not found.”错误，请在build.gradle文件中添加以下代码。
#方法二（导入module方式）：
#2.2、项目集成步骤
#2.2.1、SDK包说明
#2.2.2、导入SDK
1.
2.
3.
4.
5.
#2.2.3、添加用户权限
#2.2.4、初始化
#2.2.5、常用参数说明
| 参数名称 | 名称 | 说明 |
|---|---|---|
| domain | 应用领域 | 应用领域 iat：日常用语 medical：医疗 注：医疗领域若未授权无法使用，可到控制台-语音听写（流式版）-高级功能处添加试用或购买；若未授权无法使用会报错11200。 |
| language | 语言区域 | 选择要使用的语言区域，目前Android SDK支持 zh_cn：中文 en_us：英文 ja_jp：日语 ko_kr：韩语 ru-ru：俄语 fr_fr：法语 es_es：西班牙语 注：小语种若未授权无法使用会报错11200，可到控制台-语音听写（流式版）-方言/语种处添加试用或购买。 |
| accent | 方言 | 当前仅在LANGUAGE为简体中文时，支持方言选择，其他语言区域时，可把此参数值设为mandarin。默认值：mandarin，其他方言参数可在控制台方言一栏查看。 |
| vad_bos | 前端点检测 | 开始录入音频后，音频前面部分最长静音时长，取值范围[0,10000ms]，默认值5000ms |
| vad_eos | 后端点检测 | 开始录入音频后，音频后面部分最长静音时长，取值范围[0,10000ms]，默认值1800ms。 |
| sample_rate | 采样率 | 支持：8KHz（仅在线支持）,16KHz |
| nbest | 句子多候选 | 通过设置此参数，获取在发音相似时的句子多候选结果。设置多候选会影响性能，响应时间延迟200ms左右。取值范围：听写[1,5]。 注：该扩展功能若未授权无法使用，可到控制台-语音听写（流式版）-高级功能处免费开通；若未授权状态下设置该参数并不会报错，但不会生效。 |
| wbest | 词语多候选 | 通过设置此参数，获取在发音相似时的词语多候选结 果。设置多候选会影响性能，响应时间延迟200ms左右。取值范围：听写[1,5]。 注：该扩展功能若未授权无法使用，可到控制台-语音听写（流式版）-高级功能处免费开通；若未授权状态下设置该参数并不会报错，但不会生效。 |
| result_type | 结果类型 | 结果类型包括：xml, json, plain。xml和json即对应的结构化文本结构，plain即自然语言的文本。 |
| nunum | 数字结 果 | 通过设置此参数可偏向输出数字结果格式 0：倾向于汉字， 1：倾向于数字， 设置方式：mIat.setParameter("nunum", "0") |
| ptt | 标点符号 | （仅中文支持）标点符号添加 1：开启（默认值） 0：关闭 |
#2.2.6、在线听写UI设置
#2.2.6.1、无UI识别
#2.2.6.2、带UI识别
#2.3、个性化热词设置
#2.4、代理服务器设置方法
net_type=custom, proxy_ip=<host>, proxy_port=<port>
其中，<host>,<port>替换为实际的代理服务器地址和端口。例如：SpeechUtility.createUtility(context, SpeechConstant.APPID + “=12345678” + “,” + “net_type=custom, proxy_ip=192.168.1.2, proxy_port=8080”); 注意：各参数间，以英文逗号分隔。
接口原型： public static SpeechUtility createUtility(Context context, java.lang.String params)
注意： 若在设置代理参数后，使用语音服务过程中，报错10204/10205/10212等网络异常错误时，请查阅以下内容，做出相关操作： 讯飞语音SDK的通信协议使用的是标准HTTP1.1协议，其代理协议使用的是标准HTTP代理协议。 代理服务器需要支持全双工多问多答方式，即 pipeline 模式。 代理服务器不能对80端口做限制，不能对如下域名做拦截： hdns.openspeech.cn scs.openspeech.cn open.xf-yun.com dev.voicecloud.cn 需要确保代理服务器只负责转发数据包，不能改变数据包的完整性和时序性。 代理服务器在转发数据包时，不能在HTTP协议头部添加 IE6 标识头。
#3、参数说明
#3.1、识别结果
| JSON字段 | 英文全称 | 类型 | 说明 |
|---|---|---|---|
| sn | sentence | number | 第几句 |
| ls | last sentence | boolean | 是否最后一句 |
| bg | begin | number | 保留字段，无需关注 |
| ed | end | number | 保留字段，无需关注 |
| ws | words | array | 词 |
| cw | chinese word | array | 中文分词 |
| w | word | string | 单字 |
| sc | score | number | 分数 |
{
"sn": 1,
"ls": true,
"bg": 0,
"ed": 0,
"ws": [
{
"bg": 0,
"cw": [
{
"w": "今天",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "的",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "天气",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "怎么样",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "。",
"sc": 0
}
]
}
]
}{
"sn": 1,
"ls": false,
"bg": 0,
"ed": 0,
"ws": [
{
"bg": 0,
"cw": [
{
"w": "我想听",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "拉德斯基进行曲",
"sc": 0
},
{
"w": "拉得斯进行曲",
"sc": 0
}
]
}
]
}#3.2、动态修正
| 参数 | 类型 | 描述 |
|---|---|---|
| pgs | string | 开启wpgs会有此字段 取值为 "apd"时表示该片结果是追加到前面的最终结果；取值为"rpl" 时表示替换前面的部分结果，替换范围为rg字段 |
| rg | array | 替换范围，开启wpgs会有此字段 假设值为[2,5]，则代表要替换的是第2次到第5次返回的结果 |
{
"sn": 2,
"ls": false,
"bg": 0,
"ed": 0,
"pgs": "rpl",
"rg": [
1,
1
],
"ws": [
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "我"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "的"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "两"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "个"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "短信"
}
]
}
]
}{
"sn": 3,
"ls": false,
"bg": 0,
"ed": 0,
"pgs": "apd",
"ws": [
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "，"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "昨天"
}
]
},
{
"bg": 0,
"cw": [
{
"sc": 0.00,
"w": "晚上"
}
]
}
]
}#4、视频教程
#5、常见问题
#目前安卓平台具体支持安卓版本
答：Android版本SDK目前支持4.4以上版本，React-Native ，QT 等跨平台方案，目前暂不支持
#集成语音识别功能时，程序启动后没反应
答：请检查是否忘记使用SpeechUtility初始化。也可以在监听器的onError函数中打印错误信息，根据信息提示，查找错误源。
#SDK是否支持本地语音能力？
答：Android平台SDK已经支持本地合成、本地命令词识别、本地语音唤醒功能了，创建应用后前往应用控制台下载各服务sdk即可。
#获取到语音听写结果为空或错误内容或者内容不全的原因是什么？
答：原因可能是：
1、音频格式不正确，客户端支持的音频编解码算法只支持16位Intel PCM格式的音频，请使用Cool Edit Pro工具（网页搜索下载即可）查看音频格式，sdk目前支持的格式是 pcm 和 wav 格式、音频采样率要是 16k 或者 8k、采样精度16 位、单声道音频。
2、引擎的参数设置不正确，如没有设置好正确的引擎类型和采样率等。
3、音频中间有静音或者杂音音频超过了后端点（默认为1800ms）的设置，此时请使用Cool Edit Pro工具查看音频内容，并且设置后端点（vad_eos）为最大值10000ms
包含超过后端点最大值的静音或者杂音音频识别不完整是正常的。
#错误码21001, 21002, 20021, 创建单例返回 null
答：参考以下帖子：http://bbs.xfyun.cn/forum.php?mod=viewthread&tid=9688
#如何设置识别业务所需的额外参数（其它业务类似）？
答：如要设置参数对：abc = 123，则应写：mIat.setParameter("abc", "123"); 各类参数设置参考安卓api文档
#如何设置语音云服务URL？
答：在createUtility接口中添加：server_url = http://YourDomainName/msp.do （YourDomainName是指语音云服务域名，请开发者自行替换） 例如：SpeechUtility.createUtility(context, SpeechConstant.APPID + "=12345678" + "," + "server_url = http://sdk.openspeech.cn/msp.do");
注意：各参数间，以英文逗号分隔。 接口原型： public static SpeechUtility createUtility(Context context, java.lang.String params)
#SDK形式是否支持多路并发？
答：sdk：客户端解决方案，支持Android、ios、windows、linux等平台，不支持并发; webapi：服务端解决方案，不限制平台、不限制语言，支持并发。
#语音听写支持识别多长时间的音频，支持的音频格式是什么？
答：语音听写的功能是可以识别60S以内的短音频，将音频转化成文本信息。
听写sdk目前支持的格式是 pcm 和 wav 格式、音频采样率要是 16k 或者 8k、采样精度16 位、单声道音频。请使用cool edit软件（网页搜索下载此软件即可）查看音频格式是否满足相应的识别引擎类型，否则识别为空或者识别为错误文本，格式必须正确，除上述格式均不识别，音频格式一定要满足要求。现语音听写WebAPI接口的中文普通话和英文支持mp3格式，如有需要，请参考语音听写（流式版）WebAPI
具体可以参考：http://bbs.xfyun.cn/forum.php?mod=viewthread&tid=7051
另外我们识别的音频长度最大为 60S，在使用音频是要注意你的本地音频的参数要和代码里的读取音频参数保持一致
#安卓听写sdk如何下载？
答：文档中心---快速指引 有介绍步骤---根据步骤下载安卓在线听写sdk
#听写识别结果如何显示阿拉伯数字？
答：设置nunum=1即可优先返回阿拉伯数字。
#为什么使用音频文件返回结果为空、音频文件识别不完整？
答：音频格式不正确或者音频 格式与设置的参数不匹配。
#为什么保存的本地录音无法播放？
答：保存的音频格式为pcm格式的音频，是无法直接播放的，可下载下来使用cool edit pro进行播放。
#听写会识别手机发出的声音，如何屏蔽手机声音？
答：设置mIse.setParameter("KEY_REQUEST_FOCUS", "true");即可暂停手机声音。
#如何设置返回 结果不打印标点符号？
答：ASR_PTT表示是否返回标点符号，通过此参数，设置听写文本结果是否含标点符号。0表示不带标点，1则表示带标点。
#最多支持多少热词，是否可以扩容？
答：控制台最多支持2000个热词，暂不支持扩容。
#是否支持x86架构？
答：目前不支持x86架构。
修改于 2023-12-18 07:34:28