喜马拉雅实时音色转换插件接口说明

在声网 SDK 提供的插件相关方法和回调中，key 和 value 参数取决于你使用的插件。本页提供喜马拉雅实时音色转换插件支持的 key 和 value 说明。

插件的 key 概览

在声网 SDK 中调用插件相关 API 时，需要传入指定的 key 和 value。本节介绍喜马拉雅实时音色转换插件支持的所有 key。

方法 key

调用声网 SDK 的 setExtensionProperty 方法时，支持传入以下 key：

setExtensionProperty 方法的 key	描述
init_vc	初始化音色转换插件
start_vc	开启实时音色转换
stop_vc	停止实时音色转换

回调 key

声网 SDK 的 onEvent 回调可能包括以下 key：

类型一

这一类型的回调 key 是对 setExtensionProperty 方法处理结果的直接反馈。推荐根据 onEvent 回调返回的错误码来编写业务端逻辑。

信息

setExtensionProperty 方法运行时间不能过长，否则可能影响 SDK 运行，因此插件中对 setExtensionProperty 方法的处理都是异步调用，

onEvent 回调的 key	描述
InitOk	init_vc 执行成功
InitError	init_vc 执行出错
StartOk	start_vc 执行成功
StartError	start_vc 执行出错
StopOk	stop_vc 执行成功
StopError	stop_vc 执行出错

类型二

这一类型的回调 key 是对运行过程错误和其它状况的具体描述，可根据需要在业务端进行处理。

onEvent 回调的 key	描述
Ok	操作成功
ConfigError	配置错误
ProcessError	处理音频数据过程中出错
SetPropertyError	设置属性出错
FileOperationError	内部操作文件错误
UnknownError	其它错误
InternetError	网络错误
AuthenticationError	账号权限认证失败

方法 key 的 value 说明

init_vc

value 包含以下参数：

value 参数	描述
appkey	String 型，你在声网控制台购买和激活插件后获取的 appKey。
secret	String 型，你在声网控制台购买和激活插件后获取的 appSecret。
init_json	String 型，init.json 文件的路径。
init_dir	String 型，init.json 文件所在的目录。

init_vc 为异步调用，客户端需要通过 onEvent 回调返回的 InitOk 或 InitError 来判断是否执行成功，然后执行后面的操作。

start_vc

无 value 参数。

stop_vc

无 value 参数。

调用 stop_vc 后，虽然停止了音色转换，但是插件中可能还会有一些转换后的数据没有传给声网 SDK，因此最好通过 onEvent 回调返回的 StopOk 或 StopError 来判断是否结束，避免丢失数据。

回调 key 的 value 说明

所有回调 key 对应的 value 参数均为字符串，其中 key 代表事件类型，· 是对具体情况的描述。Android 平台上 io.agora.extension.histreamvc.ExtensionManager.java 文件中预先设置了字符串常量，可直接引用。iOS 平台需要 App 开发者自行定义。