添加插件。
public void addExtension(String providerName) {
mExtensionList.add(providerName);
}
该方法是 RtcEngineConfig 类的成员函数。
参数
参数名 | 参数描述 |
---|---|
providerName | 插件的 so 或 aar 文件名 |
启用/禁用插件。
public abstract int enableExtension(String provider, String extension, boolean enable);
参数
参数名 | 参数描述 | 你需要传入的值 |
---|---|---|
provider | 提供插件的服务商名称 | Unisound |
extension | 插件的名称 | ASR_EVAL |
enable | 是否启用插件 | true : 启用插件。false : 禁用插件。 |
返回值
设置插件的属性。需要在启用插件后调用。
public abstract int setExtensionProperty(String provider, String extension, String key, String value);
参数
参数名 | 参数描述 | 你需要传入的值 |
---|---|---|
provider | 提供插件的服务商名称 | Unisound |
extension | 插件的名称 | ASR_EVAL |
key | 插件属性的 Key | 详见 key-value 列表 |
value | 插件属性 Key 对应的值 | 详见 key-value 列表 |
返回值
插件事件回调。
void onEvent(String provider, String extension, String key, String value);
该回调是 IMediaExtensionObserver
类的成员。为监听插件事件,你需要注册该回调。
参数
参数名 | 参数描述 |
---|---|
provider | 提供插件的服务商名称 |
extension | 插件的名称 |
key | 插件事件的 Key,详见 key-value 列表 |
value | 插件事件 Key 对应的值,详见 key-value 列表 |
启用/禁用插件。
- (int)enableExtensionWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension enabled:(BOOL)enabled;
参数
参数名 | 参数描述 | 你需要传入的值 |
---|---|---|
provider | 提供插件的服务商名称 | Unisound |
extension | 插件的名称 | ASR_EVAL |
enabled | 是否启用插件 | YES : 启用插件。NO : 禁用插件。 |
返回值
设置插件的属性。需要在启用插件后调用。
- (int)setExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key value:(NSString * __nonnull)value;
参数
参数名 | 参数描述 | 你需要传入的值 |
---|---|---|
provider | 提供插件的服务商名称 | Unisound |
extension | 插件的名称 | ASR_EVAL |
key | 插件属性的 Key | 详见 key-value 列表 |
value | 插件属性 Key 对应的值 | 详见 key-value 列表 |
返回值
插件事件回调。
- (void)onEvent:(NSString * __nullable)provider
extension:(NSString * __nullable)extension
key:(NSString * __nullable)key
value:(NSString * __nullable)value;
该回调是 AgoraMediaFilterEventDelegate
类的成员。为监听插件事件,你需要注册该回调。
参数
参数名 | 参数描述 |
---|---|
provider | 提供插件的服务商名称 |
extension | 插件的名称 |
key | 插件事件的 Key,详见 key-value 列表 |
value | 插件事件 Key 对应的值,详见 key-value 列表 |
key | 描述 | value |
---|---|---|
init_asr |
初始化 | 包含以下参数:appkey :String 型,用于鉴权的密钥。获取方式详见购买和激活插件。secret :String 型,用于鉴权的密钥。获取方式详见购买和激活插件。host :String 型,用于识别的云端地址。默认值为 wss://ws-rtasr.hivoice.cn/v1/ws? |
start_asr |
开始识别 | 详见下面的 start_asr 参数说明 |
stop_asr |
结束识别 | 无 |
start_asr 参数说明
当 key 为 start_asr
时,value 包含以下参数:
参数名 | 类型 | 必须/可选 | 描述 | 默认值 |
---|---|---|---|---|
user_id |
string | 可选 | 用户标识。建议传入,方便排查问题。 | 无 |
domain |
String | 可选 | 领域,支持设为: |
general |
lang |
String | 可选 | 语言,支持设为: |
cn |
format |
String | 可选 | 音频格式 | pcm |
sample |
String | 可选 | 采样率,支持设为: |
16k |
type |
String | 可选 | 结果类型: |
true |
punctuation |
Boolean | 可选 | 是否开启标点符号添加: |
true |
post_proc |
Boolean | 可选 | 是否开启数字格式转为阿拉伯数字格式: |
true |
acoustic_setting |
String | 可选 | 声学模型: |
near |
key | 描述 | value |
---|---|---|
asr_error |
错误类型 | String 型,错误信息 |
asr_result |
语音识别结果 | 详见下面的 asr_result 参数说明 |
asr_result 参数说明
当 key 为 asr_result
时,value 包含以下参数:
参数 | 类型 | 描述 | 是否为空 |
---|---|---|---|
code | int | 处理结果 | NO |
msg | string | 结果说明 | NO |
sid | string | 服务端生成的 session id。申请服务端排查问题时需要提供此id | NO |
type | string | 结果类型:variable :可变结果fixed :固定结果 |
NO |
text | string | 识别结果 | NO |
start_time | string | 句子开始时间,单位 ms(可变结果不返回此字段) | YES |
end_time | string | 句子结束时间,单位 ms(可变结果不返回此字段) | YES |
错误码 | 说明 | 解决方法 |
---|---|---|
0 | 正确 | |
401 | 签名校验失败 | 签名验证失败,可能原因有多种。 1. 检查 appkey,signature 是否正确 2.检查计算签名的参数 appkey,timestamp,secret 是否按照协议要求拼接。 |
403 | 时钟偏移校验失败 | 检查服务器时间是否标准,相差 5 分钟以上会报此错误 |
20101 | websocket 连接空闲时间超过 10s | 检查客户端代码 |
20102 | 参数错误 | 客户端检查参数是否正确 |
20103 | 内部错误 | 建议重试,或者提工单,工单详情请提供 sid |
20104 | 资源不足 | 建议重试,或者提工单,工单详情请提供 sid |
20105 | 音频长度超过 120 分钟 | 检查音频时长是否过长,减小音频长度 |
20106 | 非法的 appkey | 检查 appkey 是否合法 |
20107 | 套餐时长使用完 | 购买时长套餐 |
20108 | 并发超限制 | 减小并发或者购买并发套餐 |
20109 | 客户端 ip 不在白名单内 | 检查是否开启白名单,同时检查客户端出口 ip 是否在 ip 白名单中 |