云上曲率实时音视频审核插件接口说明.md

声网 SDK 的 API 参考

本节提供声网 SDK 中与使用插件相关的 API 参考。

Java

• RtcEngineConfig 类的 addExtension
• RtcEngine 类的 enableExtension
• RtcEngine 类的 setExtensionProperty
• IMediaExtensionObserver 类的 onEvent

Objective-C

• AgoraRtcEngineKit 类的 enableExtensionWithVendor
• AgoraRtcEngineKit 类的 setExtensionPropertyWithVendor
• AgoraMediaFilterEventDelegate 类的 onEvent

插件的 key 概览

在声网 SDK 中调用插件相关 API 时，需要传入指定的 key 和 value。本节介绍云上曲率实时音视频审核插件支持的所有 key。

方法 key

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

（TODO:在表格中列出 key 的名称和描述。每个 key 的名称都做成链接，格式为 key名称，这样方便跳转。 示例如下）

setExtensionProperty/setExtensionPropertyWithVendor 方法的 key	描述
startAudit	开始审核
closeAudit	结束审核

回调 key

声网 SDK 的 onEvent 回调包括对使用中出现的各类错误信息。具体的错误信息请参考错误代码。

方法 key 的 value 说明

startAudit

value 包含以下参数：

value 参数	描述
appKey	app标识。需要填入开通插件时返回的appKey内容
appSecret	app加密秘钥。需要填入开通插件时返回的appSecret内容
streamId	音视频流ID。有业务侧自行生成
audioLang	音视频流语言。如果不传此参数，云上曲率会提供语种识别服务进行语言的识别
callbackUrl	审核结果需要云上曲率服务器回调的URL地址

审核结果会以HTTP请求的形式直接发送到你在调用 startAudit 时通过 callbackUrl 设置的地址。默认情况下，只有在检测到违规内容（包括音频和视频）时，才会回调审核结果。审核结果的回调参数解释参考图片审核接口说明、音频审核接口说明。

closeAudit

value 包含以下参数：

value 参数	描述
end	结束实时音视频审核

回调 key 的 value 说明

具体的错误信息请参考错误代码。