声网 SDK 的 API 参考
本节提供声网 SDK 中插件相关 API 的参考文档。
Android
iOS
插件的 key 概览
方法 key
调用声网 SDK 的 setExtensionProperty
/setExtensionPropertyWithVendor
方法时,支持传入以下的 key 及对应功能:
初始化
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key |
描述 |
tiInit |
初始化,在线鉴权。 |
tiInitOffline |
初始化,离线鉴权。 |
销毁
setExtensionProperty/setExtensionPropertyWithVendor 方法的 key |
描述 |
tiDestroy |
资源释放函数。 |
功能接口
回调 key
本节列出声网 SDK 的 onEvent
回调返回的 key。
方法 key 的 value 说明
tiInit
value 包含以下参数:
value 参数 |
描述 |
key |
String 型,美颜在线鉴权的秘钥。 |
tiInitOffline
value 包含以下参数:
value 参数 |
描述 |
key |
String 型,美颜离线鉴权的秘钥。 |
tiDestroy
value 包含以下参数:
value 参数 |
描述 |
enable |
BOOL 型,是否确认释放资源。 |
tiSetBeautyEnable
value 包含以下参数:
value 参数 |
描述 |
enable |
BOOL 型,是否开启美颜功能。 |
tiSetFaceTrimEnable
value 包含以下参数:
value 参数 |
描述 |
enable |
BOOL 型,是否开启美型功能。 |
tiSetMakeupEnable
value 包含以下参数:
value 参数 |
描述 |
enable |
BOOL 型,是否开启美妆功能。 |
tiSetBeauty
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,美颜特效的名称。 |
param |
Int 型,美颜特效的幅度。 |
具体的 name 和 param 见下表:
name 参数 |
中文名称 |
param 范围 |
skinWhitening |
美白 |
[0,100] |
skinBlemishRemoval |
磨皮 |
[0,100] |
skinTenderness |
粉嫩 |
[0,100] |
skinSharpness |
清晰 |
[0,100] |
skinBrightness |
亮度 |
[-50,50] |
skinPreciseBeauty |
精细磨皮 |
[0,100] |
preciseTenderness |
精细粉嫩 |
[0,100] |
highlight |
立体 |
[0,100] |
darkCircle |
黑眼圈 |
[0,100] |
crowsFeet |
鱼尾纹 |
[0,100] |
nasolabialFold |
法令纹 |
[0,100] |
tiSetReshape
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,美型特效的名称。 |
param |
Int 型,美型特效的幅度。 |
具体的name和param见下表:
name 参数 |
中文名称 |
param 范围 |
eyeMagnifying |
大眼 |
[0,100] |
chinSlimming |
瘦脸 |
[0,100] |
faceNarrowing |
窄脸 |
[0,100] |
jawTransforming |
下巴 |
[-50,50] |
foreheadTransforming |
额头 |
[-50,50] |
cheekboneSlimming |
瘦颧骨 |
[0,100] |
jawboneSlimming |
瘦下颌 |
[0,100] |
jawSlimming |
削下巴 |
[0,100] |
eyeInnerCorners |
内眼角 |
[-50,50] |
eyeOuterCorners |
外眼尾 |
[-50,50] |
eyeSpacing |
眼间距 |
[-50,50] |
eyeCorners |
倾斜 |
[-50,50] |
noseMinifying |
瘦鼻 |
[0,100] |
noseElongating |
长鼻 |
[-50,50] |
mouthTransforming |
嘴型 |
[-50,50] |
mouthHeight |
嘴高低 |
[-50,50] |
mouthLipSize |
唇厚薄 |
[-50,50] |
mouthSmiling |
扬嘴角 |
[0,100] |
browHeight |
眉高低 |
[-50,50] |
browLength |
眉长短 |
[-50,50] |
browSpace |
眉间距 |
[-50,50] |
browSize |
眉粗细 |
[-50,50] |
browCorner |
提眉峰 |
[0,100] |
tiSetFaceShape
value 包含以下参数:
value 参数 |
描述 |
enumId |
Int 型,脸型类型的枚举值。具体取值详见 TiFaceShapeEnum。 |
param |
Int 型,脸型特效的幅度。取值为[0,100]。 |
tiSetOnekeyBeauty
value 包含以下参数:
value 参数 |
描述 |
enumId |
Int 型,一键美颜类型的枚举值。具体取值详见 TiOnekeyBeautyEnum。 |
param |
Int 型,一键美颜特效的幅度。取值为[0,100]。 |
tiGetFaceNumber
value 包含以下参数:
tiSetFilter
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,滤镜特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
param |
Int 型,滤镜特效的幅度。取值为[0,100]。 |
tiSetRock
value 包含以下参数:
value 参数 |
描述 |
enumId |
Int 型,抖动特效类型的枚举值。具体取值详见 TiRockEnum。 |
tiSetDistortion
value 包含以下参数:
tiSetSticker
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,贴纸道具的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetInteraction
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,互动特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetMask
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,面具特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetGift
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,礼物特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetWatermark
value 包含以下参数:
value 参数 |
描述 |
enable |
BOOL 型,是否开启水印。 |
x |
Int 型,水印左上角的横坐标比例值。取值为[0,100)。 |
y |
Int 型,水印右上角的纵坐标比例值。取值为[0,100)。 |
ratio |
Int 型,水印横向占据画面的比例。注:x + ratio <= 100。 |
name |
String 型,水印特效的名称。注:需要包含.png后缀。 |
tiSetGreenScreen
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,绿幕特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetPortrait
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,人像抠图特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetGesture
value 包含以下参数:
value 参数 |
描述 |
name |
String 型,手势识别特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
tiSetHair
value 包含以下参数:
value 参数 |
描述 |
enumId |
Int 型,美发特效类型的枚举值。具体取值详见 TiHairEnum。 |
param |
Int 型,美发特效的幅度。取值为[0,100]。 |
tiSetMakeUp
value 包含以下参数:
value 参数 |
描述 |
type |
String 型,美妆特效的类型。 |
name |
String 型,美妆特效的名称。可从 assets 文件 /TiSDKResource.bundle 里查看。 |
param |
Int 型,美妆特效的幅度。取值为[0,100]。 |
对应的 type 见下表:
type 参数 |
中文名称 |
blusher |
腮红 |
eyeBrow |
眉毛 |
eyeShadow |
眼影 |
lipGLoss |
唇彩 |
tiSetTrackDistance
value 包含以下参数:
value 参数 |
描述 |
level |
Int 型,人脸识别距离的级别。取值为[0,6]。 |
tiSetFaceNumber
value 包含以下参数:
value 参数 |
描述 |
faceNumber |
Int 型,最大可支持的人脸数量。取值为[1,5]。 |
tiIsMirror
value 包含以下参数:
value 参数 |
描述 |
isMirror |
BOOL 型,是否设置道具特效的镜像展示,默认为 true 。 |
回调 key 的 value 说明
tiGetFaceNumber
value 包含以下参数:
value 参数 |
描述 |
faces |
Int 型,正在跟踪的人脸数量。 |