API文档
产品定价
(1) 概念解释
实时语音识别:可实现对连续音频流的实时识别,转换成文本信息并返对应文字流
(2) 说明
Hi,您好,欢迎使用有道智云实时语音识别Android SDK。
本文档主要针对需要集成实时语音识别的Android开发工程师,详细描述实时语音识别能力相关的技术内容。
如果您想快速体验服务,建议您前往 语音识别体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云语音技术交流QQ群:861723255
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建 Android 应用,并绑定实例;如果您还没有,请按照 新手指南 操作。 平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 实时语音识别服务报价 。
实时语音识别SDK是对有道实时语音识别接口服务进行封装。提供快速的接入方式;同时提供数据统计能力,方便了解用户使用情况。
支持设备:运行了 Android 4.0.3以及以上系统的 Android 设备
开始集成SDK之前开发者需要登录 有道智云平台 ,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用实时语音识别服务。
(1) SDK包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将ydasrsdk-v2.0.2.jar拷贝到 libs 目录下,并将以下代码添加到app的build.gradle中:
dependencies {
...
implementation "android.arch.lifecycle:extensions:1.1.1"
implementation "android.arch.lifecycle:common-java8:1.1.1"
implementation "com.squareup.okhttp3:okhttp:3.11.0"
implementation "com.google.code.gson:gson:2.8.5"
implementation "org.jetbrains.kotlin:kotlin-stdlib:1.3.0"
implementation files('libs/ydasrsdk-v2.0.2.jar')
}
(2) AndroidManifest配置
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.BROADCAST_STICKY" />
<uses-permission android:name="android.permission.BLUETOOTH" />
其中 RECORD_AUDIO、WRITE_EXTERNAL_STORAGE和READ_EXTERNAL_STORAGE 权限需要动态申请,申请权限代码可见demo代码所示。
(3) 代码混淆配置
代码混淆文件proguard-project.txt,添加如下内容:
# Gson
-keepattributes Signature
-keepattributes *Annotation*
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
#okhttp3
-dontwarn com.squareup.okhttp3.**
-keep class com.squareup.okhttp3.** { *;}
-dontwarn okhttp3.**
-dontwarn okio.**
-dontwarn javax.annotation.**
-dontwarn org.conscrypt.**
#lifecycle
-keep public class android.arch.lifecycle.** {
public protected *;
}
-keepclassmembers class ** {
@android.arch.lifecycle.OnLifecycleEvent public *;
}
#kotlin
-dontwarn kotlin.**
#AsrSdk
-keep class com.youdao.ydasr.** { *; }
-keep interface com.youdao.ydasr.** { *; }
-keep class com.youdao.audio.** { *; }
-keep interface com.youdao.audio.** { *; }
(1) 创建asr返回接口
private AsrListener mAsrListener = new AsrListener() {
// 开始识别回调
@Override
public void onAsrStart() {}
// 重连后再次连接成功回调
@Override
public void onAsrRestart() {}
// 结束识别回调
@Override
public void onAsrStop() {}
// 正在重连提示
@Override
public void onAsrReconnecting() {}
// 错误回调
@Override
public void onAsrError(@NotNull AsrResultCode error) {
// ASR结果回调, isSentence当前一句是否结束,是否是完整的句子
@Override
public void onAsrNext(@NotNull AsrResult result, boolean isSentence) {}
// 音量变化回调
@Override
public void onAsrVolumeChange(float volume) {}
// 后端点静音回调
@Override
public void onAsrSilentEnd() {}
// 前端点静音回调
@Override
public void onAsrSilentStart() {}
// 连接上蓝牙麦克风提示
@Override
public void onBluetoothAudioConnected() {}
// 蓝牙麦克风断开提示
@Override
public void onBluetoothAudioDisconnected() {}
};
(2) 创建AsrManager
在activity中创建AsrManager,初始化的参数包含appKey(如何获取见集成前提)并注册生命周期观察
mAsrManager = AsrManager.getInstance(this, Consts.AsrAppKey, mAsrListener);
getLifecycle().addObserver(mAsrManager);
(3) 开始识别
Map<String, Object> params = new HashMap<>();
params.put(AsrParams.LANG, mLang);
params.put(AsrParams.SILENT_TIMEOUT_START, 5000L);
params.put(AsrParams.SILENT_TIMEOUT_END, 10000L);
params.put(AsrParams.SENTENCE_TIMEOUT, 3000L);
params.put(AsrParams.CONNECT_TIMEOUT, 10000L);
params.put(AsrParams.WAIT_SERVER_DISCONNECT, true);
mAsrManager.start(params);
注:音频文件仅支持16k采样的wav音频
(4) 停止识别
mAsrManager.stop();
(5) 插入本地数据
Map<String, Object> params = new HashMap<>();
params.put(AsrParams.LANG, mLang);
params.put(AsrParams.SILENT_TIMEOUT_START, 5000L);
params.put(AsrParams.SILENT_TIMEOUT_END, 10000L);
params.put(AsrParams.SENTENCE_TIMEOUT, 3000L);
params.put(AsrParams.CONNECT_TIMEOUT, 10000L);
params.put(AsrParams.WAIT_SERVER_DISCONNECT, true);
mAsrManager.startConnect(params);
然后在asr回掉的onAsrStart中插入本地文件流
mAsrManager.insertAudioBytes(bytes);
{
"result": [{
"st": [{
"bg": 30,
"ed": 480,
"ws": [{
"w": "Have",
"wb": 30,
"we": 240
}, {
"w": "a",
"wb": 240,
"we": 270
}, {
"w": "good",
"wb": 270,
"we": 480
}, {
"w": "day.",
"wb": 480,
"we": 480
}]
}],
"seg_id": 0
}],
"errorCode": "0",
"action": "recognition"
}
| 参数 | 含义 | 说明 |
|---|---|---|
| errorCode | String | 状态码,详见 错误代码列表 |
| action | String | 状态标。started:握手;recognition:识别;error:错误 |
| result | String | 识别结果数据 |
| bg | 分句开始时间 | 单位毫秒/ms |
| ed | 分句结束时间 | 单位毫秒/ms |
| w | 词(字)识别结果 | |
| wb | 词(字)开始时间 | 单位毫秒/ms |
| we | 词(字)结束时间 | 单位毫秒/ms |
| seg_id | 分句 id | 从 0 开始递增 |
| language | 语种(中文) | 语言代码 |
|---|---|---|
| Arabic (United Arab Emirates) | 阿拉伯语(阿拉伯联合酋长国) | ar-AE |
| Arabic (Bahrain) | 阿拉伯语(巴林) | ar-BH |
| Arabic (Algeria) | 阿拉伯语(阿尔及利亚) | ar-DZ |
| Arabic (Egypt) | 阿拉伯语(埃及) | ar-EG |
| Arabic (Israel) | 阿拉伯语(以色列) | ar-IL |
| Arabic (Iraq) | 阿拉伯语(伊拉克) | ar-IQ |
| Arabic (Jordan) | 阿拉伯语(约旦) | ar-JO |
| Arabic (Kuwait) | 阿拉伯语(科威特) | ar-KW |
| Arabic (Lebanon) | 阿拉伯语(黎巴嫩) | ar-LB |
| Arabic (Morocco) | 阿拉伯语(摩洛哥) | ar-MA |
| Arabic (Oman) | 阿拉伯语(阿曼) | ar-OM |
| Arabic (State of Palestine) | 阿拉伯语(巴勒斯坦国) | ar-PS |
| Arabic (Qatar) | 阿拉伯语(卡塔尔) | ar-QA |
| Arabic (Saudi Arabia) | 阿拉伯语(沙特阿拉伯) | ar |
| Arabic (Tunisia) | 阿拉伯语(突尼斯) | ar-TN |
| German (Germany) | 德国(德国) | de |
| English (Australia) | 英语(澳大利亚) | en-AUS |
| English (Canada) | 英语(加拿大) | en-CA |
| English (United Kingdom) | 英语(英国) | en-GBR |
| English (Ghana) | 英语(加纳) | en-GH |
| English (Ireland) | 英语(爱尔兰) | en-IE |
| English (India) | 英语(印度) | en-IND |
| English (Kenya) | 英语(肯尼亚) | en-KE |
| English (Nigeria) | 英语(尼日利亚) | en-NG |
| English (New Zealand) | 英语(新西兰) | en-NZ |
| English (Philippines) | 英语(菲律宾) | en-PH |
| English (Singapore) | 英语(新加坡) | en-SG |
| English (Tanzania) | 英语(坦桑尼亚) | en-TZ |
| English (United States) | 英语(美国) | en |
| English (South Africa) | 英语(南非) | en-ZAF |
| Spanish (Argentina) | 西班牙语(阿根廷) | es-AR |
| Spanish (Bolivia) | 西班牙语(玻利维亚) | es-BO |
| Spanish (Chile) | 西班牙语(智利) | es-CL |
| Spanish (Colombia) | 西班牙语(哥伦比亚) | es-COL |
| Spanish (Costa Rica) | 西班牙语(哥斯达黎加) | es-CR |
| Spanish (Dominican Republic) | 西班牙语(多米尼加共和国) | es-DO |
| Spanish (Ecuador) | 西班牙语(厄瓜多尔) | es-EC |
| Spanish (Spain) | 西班牙语(西班牙) | es |
| Spanish (Guatemala) | 西班牙语(危地马拉) | es-GT |
| Spanish (Honduras) | 西班牙语(洪都拉斯) | es-HN |
| Spanish (Mexico) | 西班牙语(墨西哥) | es-MEX |
| Spanish (Nicaragua) | 西班牙语(尼加拉瓜) | es-NI |
| Spanish (Panama) | 西班牙语(巴拿马) | es-PA |
| Spanish (Peru) | 西班牙语(秘鲁) | es-PE |
| Spanish (Puerto Rico) | 西班牙语(波多黎各) | es-PR |
| Spanish (Paraguay) | 西班牙语(巴拉圭) | es-PY |
| Spanish (El Salvador) | 西班牙语(萨尔瓦多) | es-SV |
| Spanish (United States) | 西班牙语(美国) | es-US |
| Spanish (Uruguay) | 西班牙语(乌拉圭) | es-UY |
| Spanish (Venezuela) | 西班牙语(委内瑞拉) | es-VE |
| French (Canada) | 法语(加拿大) | fr-CA |
| French (Canada) | 法语(加拿大) | fr-CAN |
| French (France) | 法国(法国) | fr |
| Italian (Italy) | 意大利(意大利) | it |
| Japanese (Japan) | 日本(日本) | ja |
| Korean (South Korea) | 朝鲜(韩国) | ko |
| Dutch (Netherlands) | 荷兰(荷兰) | nl |
| Polish (Poland) | 波兰(波兰) | pl |
| Portuguese (Brazil) | 葡萄牙语(巴西) | pt-BRA |
| Russian (Russia) | 俄罗斯(俄罗斯) | ru |
| Thai (Thailand) | 泰国(泰国) | th |
| Turkish (Turkey) | 土耳其(土耳其) | tr |
| Chinese, Mandarin (Simplified, China) | 中文、普通话(简体、中国) | zh-CHS |
| Chinese, Mandarin (Simplified, Hong Kong) | 中文、普通话(简体,香港) | zh-HK |
| Chinese, Mandarin (Simplified, Taiwan) | 中文、普通话(简体、台湾) | zh-TWN |
| Bulgarian (Bulgaria) | 保加利亚(保加利亚) | bg |
| Catalan (Spain) | 加泰罗尼亚语(西班牙) | ca |
| Czech (Czech Republic) | 捷克(捷克) | cs |
| Danish (Denmark) | 丹麦(丹麦) | da |
| Greek (Greece) | 希腊(希腊) | el |
| Finnish (Finland) | 芬兰(芬兰) | fi |
| Hebrew (Israel) | 希伯来语(以色列) | he |
| Hindi (India) | 印地语(印度) | hi |
| Croatian (Croatia) | 克罗地亚(克罗地亚) | hr |
| Hungarian (Hungary) | 匈牙利(匈牙利) | hu |
| Indonesian (Indonesia) | 印尼(印度尼西亚) | id |
| Lithuanian (Lithuania) | 立陶宛(立陶宛) | lt-LT |
| Latvian (Latvia) | 拉脱维亚(拉脱维亚) | lv-LV |
| Norwegian Bokmål (Norway) | 挪威书面挪威语(挪威) | no |
| Portuguese (Portugal) | 葡萄牙语(葡萄牙) | pt |
| Romanian (Romania) | 罗马尼亚(罗马尼亚) | ro |
| Slovak (Slovakia) | 斯洛伐克(斯洛伐克) | sk |
| Slovenian (Slovenia) | 斯洛文尼亚(斯洛文尼亚) | sl |
| Serbian (Serbia) | 塞尔维亚(塞尔维亚) | sr-RS |
| Swedish (Sweden) | 瑞典(瑞典) | sv |
| Ukrainian (Ukraine) | 乌克兰(乌克兰) | uk |
| Vietnamese (Vietnam) | 越南(越南) | vi |
| Afrikaans (South Africa) | 布尔语(南非) | af-ZA |
| Amharic (Ethiopia) | 阿姆哈拉语(埃塞俄比亚) | am-ET |
| Azerbaijani (Azerbaijan) | 阿塞拜疆(阿塞拜疆) | az-AZ |
| Bengali (Bangladesh) | 孟加拉(孟加拉) | bn-BD |
| Bengali (India) | 孟加拉语(印度) | bn-IN |
| Estonian (Estonia) | 爱沙尼亚(爱沙尼亚) | et-EE |
| Basque (Spain) | 巴斯克(西班牙) | eu-ES |
| Persian (Iran) | 波斯(伊朗) | fa-IR |
| Filipino (Philippines) | 菲律宾(菲律宾) | tl |
| Galician (Spain) | 加利西亚(西班牙) | gl-ES |
| Gujarati (India) | 古吉拉特语(印度) | gu-IN |
| Armenian (Armenia) | 亚美尼亚(亚美尼亚) | hy-AM |
| Icelandic (Iceland) | 冰岛(冰岛) | is-IS |
| Javanese (Indonesia) | 爪哇(印度尼西亚) | jv-ID |
| Georgian (Georgia) | 格鲁吉亚(Georgia) | ka-GE |
| Khmer (Cambodia) | 红色(高棉语) | km-KH |
| Kannada (India) | 埃纳德语(印度) | kn-IN |
| Lao (Laos) | 老挝(老挝) | lo |
| Macedonian (North Macedonia) | 马其顿(北马其顿) | mk-MK |
| Malayalam (India) | 马拉雅拉姆语(印度) | ml-IN |
| Mongolian (Mongolia) | 蒙古(蒙古) | mn-MN |
| Marathi (India) | 马拉地语(印度) | mr-IN |
| Malay (Malaysia) | 马来语(马来西亚) | ms |
| Burmese (Myanmar) | 缅甸(缅甸) | my-MM |
| Nepali (Nepal) | 尼泊尔(尼泊尔) | ne-NP |
| Punjabi (Gurmukhi, India) | 旁遮普(果鲁穆奇语、印度) | pa-guru-IN |
| Sinhala (Sri Lanka) | 僧伽罗语(斯里兰卡) | si-LK |
| Albanian (Albania) | 阿尔巴尼亚(阿尔巴尼亚) | sq-AL |
| Sundanese (Indonesia) | 巽他语(印度尼西亚) | su-ID |
| Swahili (Kenya) | 斯瓦希里语(肯尼亚) | sw-KE |
| Swahili (Tanzania) | 斯瓦希里语(坦桑尼亚) | sw-TZ |
| Tamil (India) | 泰米尔语(印度) | ta |
| Tamil (Sri Lanka) | 泰米尔语(斯里兰卡) | ta-LK |
| Tamil (Malaysia) | 泰米尔语(马来西亚) | ta-MY |
| Tamil (Singapore) | 泰米尔语(新加坡) | ta-SG |
| Telugu (India) | 泰卢固语(印度) | te |
| Urdu (India) | 乌尔都语(印度) | ur-IN |
| Urdu (Pakistan) | 乌尔都语(巴基斯坦) | ur-PK |
| Uzbek (Uzbekistan) | 乌兹别克斯坦(乌兹别克斯坦) | uz-UZ |
| Chinese, Cantonese (Traditional, Hong Kong) | 中文、粤语(繁体、香港) | yue |
| Zulu (South Africa) | 祖鲁语(南非) | zu-ZA |
| 错误码 | 含义 |
|---|---|
| 101 | 缺少必填的参数 |
| 102 | 不支持的语言类型 |
| 103 | 翻译文本过长 |
| 104 | 不支持的API类型 |
| 105 | 不支持的签名类型 |
| 106 | 不支持的响应类型 |
| 107 | 不支持的传输加密类型 |
| 108 | 应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息 |
| 109 | batchLog格式不正确 |
| 110 | 无相关服务的有效实例 |
| 111 | 开发者账号无效 |
| 113 | q不能为空 |
| 114 | 不支持的图片传输方式 |
| 201 | 解密失败,可能为DES,BASE64,URLDecode的错误 |
| 202 | 签名检验失败 |
| 203 | 访问IP地址不在可访问IP列表 |
| 205 | 请求的接口与应用的平台类型不一致,如有疑问请参考入门指南 |
| 206 | 因为时间戳无效导致签名校验失败 |
| 207 | 重放请求 |
| 301 | 辞典查询失败 |
| 302 | 翻译查询失败 |
| 303 | 服务端的其它异常 |
| 304 | 会话闲置太久超时 |
| 401 | 账户已经欠费停 |
| 402 | offlinesdk不可用 |
| 411 | 访问频率受限,请稍后访问 |
| 412 | 长请求过于频繁,请稍后访问 |
| 1001 | 无效的OCR类型 |
| 1002 | 不支持的OCR image类型 |
| 1003 | 不支持的OCR Language类型 |
| 1004 | 识别图片过大 |
| 1201 | 图片base64解密失败 |
| 1301 | OCR段落识别失败 |
| 1411 | 访问频率受限 |
| 1412 | 超过最大识别字节数 |
| 2003 | 不支持的语音声道 |
| 2004 | 不支持的语音上传类型 |
| 2005 | 不支持的语言类型 |
| 2006 | 不支持的识别类型 |
| 2201 | 识别音频文件过大 |
| 2301 | 识别音频时长过长 |
| 2411 | 不支持的音频文件类型 |
| 2412 | 不支持的发音类型 |
| 3001 | 不支持的语音格式 |
| 3002 | 不支持的语音采样率 |
| 3003 | 不支持的语音声道 |
| 3004 | 不支持的语音上传类型 |
| 3005 | 不支持的语言类型 |
| 3006 | 不支持的识别类型 |
| 3007 | 识别音频文件过大 |
| 3008 | 识别音频时长过长 |
| 3009 | 不支持的音频文件类型 |
| 3010 | 不支持的发音类型 |
| 3201 | 解密失败 |
| 3301 | 语音识别失败 |
| 3302 | 语音翻译失败 |
| 3303 | 服务的异常 |
| 3411 | 访问频率受限,请稍后访问 |
| 3412 | 超过最大请求字符数 |
| 4001 | 不支持的语音识别格式 |
| 4002 | 不支持的语音识别采样率 |
| 4003 | 不支持的语音识别声道 |
| 4004 | 不支持的语音上传类型 |
| 4005 | 不支持的语言类型 |
| 4006 | 识别音频文件过大 |
| 4007 | 识别音频时长过长 |
| 4201 | 解密失败 |
| 4301 | 语音识别失败 |
| 4303 | 服务的异常 |
| 4411 | 访问频率受限,请稍后访问 |
| 4412 | 超过最大请求时长 |
| 5001 | 无效的OCR类型 |
| 5002 | 不支持的OCR image类型 |
| 5003 | 不支持的语言类型 |
| 5004 | 识别图片过大 |
| 5005 | 不支持的图片类型 |
| 5006 | 文件为空 |
| 5201 | 解密错误,图片base64解密失败 |
| 5301 | OCR段落识别失败 |
| 5411 | 访问频率受限 |
| 5412 | 超过最大识别流量 |
| 9001 | 不支持的语音格式 |
| 9002 | 不支持的语音采样率 |
| 9003 | 不支持的语音声道 |
| 9004 | 不支持的语音上传类型 |
| 9005 | 不支持的语音识别 Language类型 |
| 9301 | ASR识别失败 |
| 9303 | 服务器内部错误 |
| 9411 | 访问频率受限(超过最大调用次数) |
| 9412 | 超过最大处理语音长度 |
| 10001 | 无效的OCR类型 |
| 10002 | 不支持的OCR image类型 |
| 10004 | 识别图片过大 |
| 10201 | 图片base64解密失败 |
| 10301 | OCR段落识别失败 |
| 10411 | 访问频率受限 |
| 10412 | 超过最大识别流量 |
| 13001 | 不支持的角度类型 |
| 13002 | 不支持的文件类型 |
| 13003 | 表格识别图片过大 |
| 13004 | 文件为空 |
| 13301 | 表格识别失败 |
| 17001 | 需要图片 |
| 17002 | 图片过大(1M) |
| 17003 | 识别类型未找到 |
| 17004 | 不支持的识别类型 |
| 17005 | 服务调用失败 |
| -1000 | 未知错误 |
| -2000 | 查询输入为空 |
null
C:/Users/liuyanyan/.gradle/caches/transforms-1/files-1.1/appcompat-v7-28.0.0.aar/7cbab2e2b4c7701e76fa4d46215a4687/res/values-v28/values-v28.xml
D:/workdir/ydasrDemo
C:/Users/liuyanyan/.gradle/caches/transforms-1/files-1.1/appcompat-v7-28.0.0.aar/7cbab2e2b4c7701e76fa4d46215a4687/res/values/values.xml
null
failed linking references.
targetSdkVersion 28
...
dependencies {
...
implementation 'com.android.support:appcompat-v7:28.0.0'
}
null
Default interface methods are only supported starting with Android N (--min-api 24): void android.arch.lifecycle.DefaultLifecycleObserver.onCreate(android.arch.lifecycle.LifecycleOwner)
Stripped invalid locals information from 1 method.
null
com.android.builder.dexing.DexArchiveBuilderException: Failed to process C:\Users\liuyanyan\.gradle\caches\modules-2\files-2.1\android.arch.lifecycle\common-java8\1.1.1\795d68cd761d093ccb235d1d91b8fd17c2ae25ff\common-java8-1.1.1.jar
com.android.builder.dexing.DexArchiveBuilderException: Error while dexing.
com.android.tools.r8.CompilationFailedException: Compilation failed to complete
com.android.tools.r8.utils.AbortException
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
| 上线日期 | 版本号 | 更新内容 |
|---|---|---|
| 2018.11.12 | v1.0.0 | 支持在线实时语音识别 |
| 2019.11.12 | v2.0.0 | 支持插入本地语音 |
| 2023.08.09 | v2.0.2 | 升级支持语言 |