本节提供声网 SDK 中插件相关 API 的参考文档。
RtcEngineConfig
类的 addExtensionRtcEngine
类的 enableExtensionRtcEngine
类的 setExtensionPropertyRtcEngine
类的 getExtensionPropertyIMediaExtensionObserver
类的 onEventAgoraRtcEngineKit
类的 enableExtensionWithVendorAgoraRtcEngineKit
类的 setExtensionPropertyWithVendorAgoraRtcEngineKit
类的 getExtensionPropertyWithVendorAgoraMediaFilterEventDelegate
类的 onEvent在声网 SDK 中调用插件相关 API 时,需要传入指定的 key 和 value。本节介绍标贝声音转换插件支持的所有 key。
调用声网 SDK 的 setExtensionProperty
/setExtensionPropertyWithVendor
方法时,支持传入以下 key:
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key | 说明 |
---|---|
authors | 设置授权 |
voiceName | 设置音色 |
enable | 插件开关 |
isLog | 日志开关 |
声网 SDK 的 onEvent
回调可能包括以下 key:
Android
onEvent 回调的 key | 描述 |
---|---|
0000 | 请求成功 |
1001 | 没有读写权限 |
1002 | 没有录音权限 |
1003 | 采样率仅支持 16k |
1004 | 传入 JSON 数据异常 |
2001 | 鉴权失败,可能原因包括安装量不足或者网络错误 |
3001 | 引擎内部错误 |
iOS
onEvent 回调的 key | 描述 |
---|---|
Authors | 鉴权失败,可能原因包括安装量不足或者网络错误 |
22190010 | 请求授权参数报错 |
22190011 | 获取token报错 |
22190012 | 授权无效 |
22190013 | 设备信息鉴权失败 |
3001 | 引擎初始化失败 |
3002 | 引擎接口调用失败 |
3003 | 传给引擎的参数错误 |
3004 | 引擎内存不足 |
3005 | 引擎内部运行失败 |
value 包含以下参数:
clientId
:String 型,购买插件后获取的 clientId。clientSecret
:String 型,购买插件后获取的 clientSecret。voiceName
:String 型,要使用的音色类型。value 为 String 型,代表发言人的音色,支持设为以下值:
Vc_luoli
:萝莉。Vc_dashu
:大叔。Vc_kongling
:空灵。Vc_bawanglong
:霸王龙。Vc_zhongjinshu
:机械音。value 为 Boolean 型,代表是否开启插件。
value 为 Boolean 型,代表是否开启日志。开启日志后,插件会在本地路径保存转换前后的语音信息。
所有回调 key 对应的 value 参数均为字符串,其中 key 代表错误码,value 是对错误情况的具体描述。