虹图人像 3D 特效系列插件接口说明

声网 SDK 的 API 参考

本节提供声网 SDK 中插件相关 API 的参考文档。

Android

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

iOS

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

插件的 key 概览

方法 key

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

初始化

setExtensionProperty/setExtensionPropertyWithVendor 方法的 key	描述
htARInitOffline	初始化，离线鉴权。

销毁

setExtensionProperty/setExtensionPropertyWithVendor 方法的 key	描述
htARReleaseBufferRenderer	资源释放函数。

功能接口

setExtensionProperty/setExtensionPropertyWithVendor 方法的 key	描述
htARRenderEnable	开启/关闭 AR 特效函数。
htARSetModel	切换 AR 模型函数。
htARMirror	设置图像是否存在镜像函数。
htARImageFormat	设置图像格式函数。
htARRotation	设置图像旋转角度函数。
htARMaxFaces	设置最大可支持人脸数量函数。
htARCopyResource	拷贝资源路径到沙盒函数。

方法 key 的 value 说明

htARInitOffline

value 包含以下参数：

value 参数	描述
license	String 型，AR 离线鉴权的秘钥。

htARReleaseBufferRenderer

value 包含以下参数：

value 参数	描述
enable	BOOL 型，是否确认释放资源。

htARRenderEnable

value 包含以下参数：

value 参数	描述
enable	BOOL 型，是否开启 AR 功能。

htARSetModel

value 包含以下参数：

value 参数	描述
name	String 型，模型的名称。

htARMirror

value 包含以下参数：

value 参数	描述
isMirror	BOOL 型，是否设置道具特效的镜像展示，默认为 true。

htARImageFormat

value 包含以下参数：

value 参数	描述
imageFormat	Int 型，图像格式的枚举值。具体取值详见 HTEARImageFormat。

htARRotation

value 包含以下参数：

value 参数	描述
rotation	Int 型，图像旋转角度的枚举值。具体取值详见 HTEAROrientation。

htARMaxFaces

value 包含以下参数：

value 参数	描述
maxFaces	Int 型，最大可支持人脸数量。取值为[1,5]。

htARCopyResource

value 包含以下参数：

value 参数	描述
path	String 型，需要拷贝至沙盒的路径。