setOptions(common, ist, its, callback): void
设置插件功能相关参数。
参数:
common
:鉴权配置。详见 common 属性列表。ist
: 语音转写配置。详见 ist 属性列表。its
:文本翻译配置:null
即可。callback
:回调函数。详见 callback 参数说明。let common = {
// 传入购买和激活插件时从声网控制台获取的 appKey、appSecret、appId
apiKey: 'aaaaaaaaa',
apiSecret: 'bbbbbbb',
appId: '7777'
}
let ist = {
url: 'wss://ist-api.xfyun.cn/v2/ist',
req: {
// 业务对象。必选。
"business": {
// 语种。必选。"中译英":"zh_cn";"英译中":"zh_cn"。
"language": (string),
// 口音。必选。"中译英":"mandarin";"英译中":"mandarin"。
"accent": (string),
// 领域。必选。"中译英":"ist_ed_open";"英译中":"ist_ed_open"。
"domain": (string),
// 语言类型
// 值类型:int
// 值范围:
// 1:中英文模式,中文英文均可识别;
// 3:英文模式,只识别出英文
// 值默认:1
// "中译英":1;"英译中":3。
"language_type": (int),
// 动态修正。"wpgs"。
"dwa": (string)
}
}
}
let its = {
protocol: 'http', // 非必填,默认 https
url: 'localhost', // 必填,反向代理域名,代理为 https://itrans.xfyun.cn/v2/its
host: 'itrans.xfyun.cn', // 必填,固定值
path: '/v2/its', // 必填,固定值
port: 80, // 非必填,http 默认 80,https 默认 443
req: {
"business": {
"from": "cn", // 转写语种
"to": "en" // 翻译语种
}
}
}
callback
函数接收的对象包含 key
和 value
两个属性。
{
// 错误码
"code":(int),
// 提示
"message":(string)
}
{
// 错误码,0标识成功。
"code":(int),
// 错误描述
"message":(string),
// 每次会话的唯一标识
"sid":(string),
// 识别数据
"data":{
// 识别结果是否结束标识:1:识别中;2:识别结束。
"status":(int),
// 识别结果
"result":{
// 返回结果的序号
"sn":(int),
// 是否是最后一片结果
"ls":(bool),
// 子句开始时刻,ms。
"bg":(long),
// 子句结束时刻,ms。
"ed":(long),
// 开启wpgs会有此字段,取值为 "apd"时表示该片结果是追加到前面的最终结果,取值为"rpl" 时表示替换前面的部分结果,替换范围为rg字段。
"pgs":(string),
// 替换范围,开启wpgs会有该字段。
"rg":(array),
// 是否子句结束
"sub_end":(bool),
// 词组
"ws":[
{
// 词相对子句开始时刻,10ms。
"bg":(long),
// 词多候选组
"cw":[
{
"rl":0,
// 分数
"sc":(double),
// 词
"w":(string),
// 词相对子句开始时刻,10ms。
"wb":(long),
"wc":0.00,
// 词相对子句结束时刻,10ms。
"we":(long),
// 词语的属性,其中n表示正常词、s表示顺滑、p表示标点、g表示分段。
"wp":(string)
}
]
},
...
]
}
},
// 业务上下文id,唯一标识一路完整会话(包括重连成功的请求)。
"context_id":(string)
}
{
// 错误码,0标识成功。
"code":(int),
// 错误描述
"message":(string),
// 每次会话的唯一标识
"sid":(string),
// 翻译数据
"data":{
// 结果
"result":{
// 源语种
"from":(string),
// 目标语种
"to":(string),
// 翻译结果
"trans_result":{
// 源文本
"src":(string),
// 目标文本
"dst":(string)
}
}
},
// 语音转写结果序号
"ist_sn":(int)
}
enable(): void | Promise<void>;
开启插件。
该方法必须在 setOptions
之后调用。调用该方法后,如果 10s 内无音频输入,会自动停止识别。你可以重复调用该方法。
disable(): void | Promise<void>;
关闭插件。
错误码 | 说明 | 处理方式 |
---|---|---|
-101 | 未知 | 分析日志 |
-102 | 翻译请求错误 | 分析error日志,并检查参数配置或网络 |
-103 | 翻译请求失败 | 依据statusCode,通常为跨域问题,请配置反向代理等解决跨域络 |
-104 | 语音识别失败 | 一般为网络连接问题,检查网络、本地时间、以及浏览器是否允许使用wss协议 |
0 | 成功 | 无 |
错误码 | 说明 | 处理方式 |
---|---|---|
10043 | 音频解码失败 | 请检查所传的音频是否与encoding字段描述的编码格式对应。 |
10139 | 参数错误 | 引擎编解码错误 |
10221 | 服务端没有可用连接 | 提交工单 |
10222 | 有服务端组件服务连接超时 | 提交工单 |
10223 | LB找不到引擎节点 | 提交工单 |
10225 | 找不到atmos | 提交工单 |
10317 | 版本非法 | 提交工单 |
11200 | 功能未授权或授权到期 | 提交工单申请权限 |
11201 | 日流控超限 | 额外需求请提交工单 |
11202 | 秒级流控超限 | 额外需求请提交工单 |
11203 | 并发流控超限 | 额外需求请提交工单 |
11204 | 组鉴权未通过,即组内所有功能均受限 | 如有需求请提交工单 |
10160 | 请求数据格式非法 | 检查请求数据是否是合法的json |
10161 | base64解码失败 | 检查发送的数据是否使用base64编码了 |
10163 | 参数校验失败 | 由客户端参数校验失败引起,客户端需要依据返回的message字段中的描述来更改请求参数 |
10200 | 读取数据超时 | 检查是否累计10s未发送数据并且未关闭连接 |
10114 | 会话时间超时 | 会话时间超过了60000s,请控制会话时间,保持不超过60000s。 |
10313 | appid和apikey不匹配或者没有传appid | 检查请求参数 第一帧没有传app_id或者传的app_id 与api_key 不匹配。 |
11503 | 服务内部响应数据错误 | 提交工单 |
11502 | 服务配置错误 | 提交工单 |
10118 | 服务端无法解析后端响应数据 | 提交工单 |
12000 | 用户发完数据没有收到结果 | - |
12001 | 用户没有正常发送完数据 | - |
99999 | 用户异常断开连接,或者会话超时断开连接 | - |
错误码 | 说明 | 处理方式 |
---|---|---|
10324 | Sid生成失败 | 联系技术人员 |
10106 | 非法的参数 | 检查参数是否正确上传 |
10107 | 非法参数值 | 检查参数值是否在取值范围内 |
10109 | 非法的data | 检查发送的文本是否合法 |
10114 | 超时 | 检查网络是否通畅 |
11210 | appId不匹配 | 检查appid和key是否匹配 |