本节提供声网 SDK 中插件相关 API 的参考文档。
RtcEngineConfig
类的 addExtensionRtcEngine
类的 enableExtensionRtcEngine
类的 setExtensionPropertyRtcEngine
类的 getExtensionPropertyIMediaExtensionObserver
类的 onEventAgoraRtcEngineKit
类的 enableExtensionWithVendorAgoraRtcEngineKit
类的 setExtensionPropertyWithVendorAgoraRtcEngineKit
类的 getExtensionPropertyWithVendorAgoraMediaFilterEventDelegate
类的 onEvent在声网 SDK 中调用插件相关 API 时,需要传入指定的 key 和 value。本节介绍大饼 AI 变声插件支持的所有 key。
调用声网 SDK 的 setExtensionProperty
/setExtensionPropertyWithVendor
方法时,支持传入以下 key:
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key | 描述 |
---|---|
setResourcesFilePath(仅 setExtensionPropertyWithVendor 方法支持) |
设置资源文件路径。 |
startRealTimeTranscribe | 开启声音引擎。 |
stopRealTimeTranscribe | 关闭声音引擎。 |
changeSpeaker | 切换音色。 |
调用声网 SDK 的 getExtensionProperty
/getExtensionPropertyWithVendor
方法时,支持传入以下 key:
getExtensionProperty 方法的 key | 描述 |
---|---|
getSpeakersInfo | 获取音色列表。 |
声网 SDK 的 onEvent
回调可能包括以下 key:
onEvent 回调的 key | 描述 |
---|---|
startRealTimeTranscribe | 返回对应方法 key 的调用结果。 |
stopRealTimeTranscribe | 返回对应方法 key 的调用结果。 |
changeSpeaker | 返回对应方法 key 的调用结果。 |
value 参数:String 型,资源文件的路径。
value 参数:设为 "startRealTimeTranscribe"
,表示开始变声。
value 参数:String 型,音色 ID。
value 参数:设为 "stopRealTimeTranscribe"
,表示停止变声。
value 参数:无。
传入该 key 后,音色列表以 JSON 的数据形式返回。
value 可能为以下参数:
value 参数 | 描述 |
---|---|
success |
String 型,引擎启动成功。 |
license error |
String 型,license 文件鉴权失败。 |
speaker info error |
String 型,音色文件错误。 |
file not found |
String 型,找不到资源文件,如 license 文件、音色文件、模型文件。 |
fail |
String 型,引擎启动失败。 |
dir not found or package name not found |
String 型,资源文件目录或者应用包名获取失败。 |
value 可能为以下参数:
value 参数 | 描述 |
---|---|
success |
String 型,停止变声成功。 |
value 可能为以下参数:
value 参数 | 描述 |
---|---|
speaker not found |
String 型,找不到音色文件。 |
fail |
String 型,设置音色失败。 |
success |
String 型,设置音色成功。 |
调用声网 SDK 的插件相关 API 时,可能返回以下错误码:
10001
:无法找到资源文件。