接口说明
更新时间:
本节提供使用插件时所需的相关的 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:
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key
描述
startAudit_pre
开始审核
closeAudit_pre
结束审核
回调 key
声网 SDK 的 onEvent
回调包括对使用中出现的各类错误信息。具体的错误信息请参考错误代码。
方法 key 的 value 说明
startAudit_pre
value 包含以下参数:
value 参数
描述
appKey
app 标识。需要填入在声网控制台购买和激活插件后获取的 appKey。
appSecret
app 加密秘钥。需要填入在声网控制台购买和激活插件后获取的 appSecret。
streamId
音视频流 ID。由业务侧自行生成。
audioLang
音视频流语言。请参考语言支持
callbackUrl
你的回调地址,用于接收由云上曲率服务器返回的审核结果。审核结果会以 HTTP 请求的形式直接发送到你通过 callbackUrl
设置的地址。默认情况下,只有在检测到违规内容(包括音频和视频)时,才会回调审核结果。审核结果的回调参数解释参考图片审核接口说明、音频审核接口说明。
closeAudit_pre
value 包含以下参数:
value 参数
描述
end
可选参数。结束实时音视频审核。
回调 key 的 value 说明
具体的错误信息请参考错误代码。
本节提供使用插件时所需的相关的 API 参考。
Java
RtcEngineConfig
类的 addExtensionRtcEngine
类的 enableExtensionRtcEngine
类的 setExtensionPropertyIMediaExtensionObserver
类的 onEvent
Objective-C
AgoraRtcEngineKit
类的 enableExtensionWithVendorAgoraRtcEngineKit
类的 setExtensionPropertyWithVendorAgoraMediaFilterEventDelegate
类的 onEvent
插件的 key 概览
在声网 SDK 中调用插件相关 API 时,需要传入指定的 key 和 value。本节介绍云上曲率实时音视频审核插件支持的所有 key。
方法 key
调用声网 SDK 的 setExtensionProperty
/setExtensionPropertyWithVendor
方法时,支持传入以下 key:
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key | 描述 |
---|---|
startAudit_pre | 开始审核 |
closeAudit_pre | 结束审核 |
回调 key
声网 SDK 的 onEvent
回调包括对使用中出现的各类错误信息。具体的错误信息请参考错误代码。
方法 key 的 value 说明
startAudit_pre
value 包含以下参数:
value 参数 | 描述 |
---|---|
appKey |
app 标识。需要填入在声网控制台购买和激活插件后获取的 appKey。 |
appSecret |
app 加密秘钥。需要填入在声网控制台购买和激活插件后获取的 appSecret。 |
streamId |
音视频流 ID。由业务侧自行生成。 |
audioLang |
音视频流语言。请参考语言支持 |
callbackUrl |
你的回调地址,用于接收由云上曲率服务器返回的审核结果。审核结果会以 HTTP 请求的形式直接发送到你通过 callbackUrl 设置的地址。默认情况下,只有在检测到违规内容(包括音频和视频)时,才会回调审核结果。审核结果的回调参数解释参考图片审核接口说明、音频审核接口说明。 |
closeAudit_pre
value 包含以下参数:
value 参数 | 描述 |
---|---|
end |
可选参数。结束实时音视频审核。 |
回调 key 的 value 说明
具体的错误信息请参考错误代码。