key-value 说明

在声网 SDK 提供的插件相关方法和回调中，key 和 value 参数取决于你使用的插件。本页提供拓幻美颜特效系列插件支持的 key 和 value 说明。

插件的 key 概览

方法 key

本节列出调用声网 SDK 的 setExtensionProperty 方法时，支持传入的 key 及对应功能。

初始化

setExtensionProperty 方法的 key	描述
htInitHTEffectOnline	初始化，在线鉴权。
htInitHTEffectOffline	初始化，离线鉴权。

销毁

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

功能接口

setExtensionProperty 方法的 key	描述
htSetRenderEnable	开启/关闭特效函数。
htReInit	重新初始化渲染函数。
htSetBeauty	设置美肤特效函数。
htSetReshape	设置美型特效函数。
htSetHairStyling	设置美发特效函数
htSetFilter	设置滤镜特效函数。
htSetStyle	设置风格特效函数。
htSetARItem	设置 AR 道具特效函数。
htSetWatermarkParam	设置水印位置参数函数。
htSetAISegEffect	设置人像抠图特效函数。
htSetGSSegEffectScene	设置绿幕抠图特效场景函数。
htSetGSSegEffectCurtain	设置绿幕抠图特效幕布函数。
htSetGSSegEffectSimilarity	设置绿幕抠图特效相似度函数。
htSetGSSegEffectSmoothness	设置绿幕抠图特效平滑度函数。
htSetGSSegEffectTransparency	设置绿幕抠图特效透明度函数。
htSetGestureEffect	设置手势识别特效函数。
htSetExtremeLimitEnable	设置参数极致限制开起/关闭函数。
htSetIsMirror	设置镜像函数。
htSetMaxFaces	设置最大可识别人脸数量函数。

回调 key

本节列出声网 SDK 的 onEvent 回调返回的 key。

onEvent 回调的 key	描述
htInitHTEffectOfflineResult	获取离线鉴权结果函数。
htIsTracking	获取检测到人脸数量函数。

方法 key 的 value 说明

htInitHTEffectOnline

value 包含以下参数：

value 参数	描述
appId	String 型，HTEffect 在线鉴权的 appId。

htInitHTEffectOffline

value 包含以下参数：

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

htReleaseBufferRenderer

value 包含以下参数：

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

htSetRenderEnable

value 包含以下参数：

value 参数	描述
enable	BOOL 型，是否开启美颜特效功能。默认为 true。

htReInit

value 无参数。

htSetBeauty

value 包含以下参数：

value 参数	描述
type	Int 型，美肤功能类型的枚举值。具体取值详见 HTBeautyTypes。
value	Int 型，美肤功能参数。默认取值范围为 [0，100]。

htSetReshape

value 包含以下参数：

value 参数	描述
type	Int 型，美型功能类型的枚举值。具体取值详见 HTReshapeTypes。
value	Int 型，美型功能参数。默认取值范围为 [0，100]。

htSetHairStyling

value 包含以下参数：

value 参数	描述
type	Int 型，美发功能类型的枚举值。具体取值详见 HTHairTypes。
value	Int 型，美发功能参数。默认取值范围为 [0，100]。

htSetFilter

value 包含以下参数：

value 参数	描述
type	Int 型，滤镜功能类型的枚举值。具体取值详见 HTFilterTypes。
name	String 型，滤镜功能名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetStyle

value 包含以下参数：

value 参数	描述
type	Int 型，风格功能类型的枚举值。具体取值详见 HTStyleTypes。
name	String 型，风格功能名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetARItem

value 包含以下参数：

value 参数	描述
type	Int 型，AR道具功能类型的枚举值。具体取值详见 HTARItemTypes。
name	String 型，AR 道具功能名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetWatermarkParam

value 包含以下参数：

value 参数	描述
x1	Float 型，水印左上角坐标点 x 系数。
y1	Float 型，水印左上角坐标点 y 系数。
x2	Float 型，水印左下角坐标点 x 系数。
y2	Float 型，水印左下角坐标点 y 系数。
x3	Float 型，水印右下角坐标点 x 系数。
y3	Float 型，水印右下角坐标点 y 系数。
x4	Float 型，水印右上角坐标点 x 系数。
y4	Float 型，水印右上角坐标点 y 系数。

htSetAISegEffect

value 包含以下参数：

value 参数	描述
name	String 型，人像抠图特效名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetGSSegEffectScene

value 包含以下参数：

value 参数	描述
name	String 型，绿幕抠图特效场景名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetGSSegEffectCurtain

value 包含以下参数：

value 参数	描述
color	String 型，绿幕抠图特效幕布颜色。目前只支持绿幕(#00ff00)、蓝幕(#0000ff)、白幕(#ffffff)三种幕布颜色和透明幕布，默认为绿幕。

htSetGSSegEffectSimilariry

value 包含以下参数：

value 参数	描述
value	Int 型，绿幕抠图特效相似度参数。取值为 [0，100]。

htSetGSSegEffectSmoothness

value 包含以下参数：

value 参数	描述
value	Int 型，绿幕抠图特效平滑度参数。取值为 [0，100]。

htSetGSSegEffectTransparency

value 包含以下参数：

value 参数	描述
value	Int 型，绿幕抠图特效透明度参数。取值为 [0，100]。

htSetGestureEffect

value 包含以下参数：

value 参数	描述
name	String 型，手势识别特效名称。可从 assets 文件（Android）或 HTEffect.bundle（iOS）里查看。

htSetExtremeLimitEnable

value 包含以下参数：

value 参数	描述
enable	BOOL 型，是否存在参数极值限定。默认为 true，设为 false 则取消级值限定。

htSetIsMirror

value 包含以下参数：

value 参数	描述
isMirror	BOOL 型，是否存在镜像。默认为 true。

htSetMaxFaces

value 包含以下参数：

value 参数	描述
maxFaces	Int 型，设置最多可识别人脸数量。取值为 [1,5]。

回调 key 的 value 说明

htInitHTEffectOfflineResult

value 包含以下参数：

value 参数	描述
initInfo	Int 型，离线鉴权的结果值。

htIsTracking

value 包含以下参数：

value 参数	描述
faceNumber	Int 型，正在跟踪的人脸数量。