文档中心
AI 美颜
客户端 API
功能总览

功能总览

更新时间：2024-12-26 15:44

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的 AI 美颜服务。

以下为基本 API 的简要介绍。

初始化相关的前置功能

方法名	描述
getAuthInfo:appSign:	获取 SDK 授权信息，通过授权信息和 appID 可以向 ZEGO 服务器申请鉴权文件。
getDeviceLevel	获取设备手机性能等级。在Effects环境初始化之前部署来获取对应设备性能的效果能力。
getVersion	获取 Effects 版本号。
setAdvancedConfig:config:	Effects 高级功能开关。
setResources:resourceInfoList:	设置 Effects 静态资源。
create:license:	创建 Effects 实例。
create:appid:appSign:callback:	创建 Effects 实例。
destroy	销毁 Effects 对象。
setEventHandler:eventHandler:	设置事件通知回调，传 [nil] 则清空已设置的回调。
initEnv:resolution:	初始化 Effects 引擎环境。
uninitEnv	反初始化 Effects 引擎环境。
effects:errcode:desc:	错误信息回调。

美颜

方法名	描述
enableAcneRemoving:enable:	开启祛痘斑功能，可调用 [setAcneRemovingParam] 接口设置祛痘斑参数。
enableClarity:enable:	开启清晰功能，可调用 [setClarityParam] 接口设置清晰参数。
enableDarkCirclesRemoving:enable:	开启黑眼圈去除功能，可调用 [setDarkCirclesRemovingParam] 接口设置黑眼圈去除参数。
enableSkinColor:enable:	开启换肤功能
enableWrinklesRemoving:enable:	开启法令纹去除功能，可调用 [setWrinklesRemovingParam] 接口设置法令纹去除参数。
setAcneRemovingParam:param:	设置祛痘斑参数。
setClarityParam:param:	设置清晰参数。
setDarkCirclesRemovingParam:param:	设置黑眼圈去除参数。
setSkinColorParam:param:	设置换肤参数。
setSkinColorResPath:bundlePath:	设置换肤资源路径参数。
setWrinklesRemovingParam:param:	设置法令纹去除参数。
enableRosy:enable:	开启红润功能，可调用 [setRosyParam] 接口设置红润参数。
enableSharpen:enable:	开启锐化功能，可调用 [setSharpenParam] 接口设置锐化参数。
enableSmooth:enable:	开启磨皮功能，可调用 [setSmoothParam] 接口设置磨皮参数。
setRosyParam:param:	设置红润参数。
setSharpenParam:param:	设置锐化参数。
setSmoothParam:param:	设置磨皮参数。
enableWhiten:enable:	开启美白功能。
setWhitenParam:param:	设置美白参数。

美型

方法名	描述
enableCheekboneSlimming:enable:	开启瘦颧骨功能，可调用 [setCheekboneSlimmingParam] 接口设置瘦颧骨参数。
enableFaceShortening:enable:	开启小脸功能，可调用 [setFaceShorteningParam] 接口设置小脸参数。
enableForeheadShortening:enable:	开启缩小额头高度功能，可调用 [setForeheadShorteningParam] 接口设置缩小额头高度参数。
enableMandibleSlimming:enable:	开启瘦下颌骨功能，可调用 [setMandibleSlimmingParam] 接口设置瘦下颌骨参数。
enableNoseLengthening:enable:	开启长鼻功能，可调用 [setNoseLengtheningParam] 接口设置长鼻参数。
setCheekboneSlimmingParam:param:	设置瘦颧骨参数。
setFaceShorteningParam:param:	设置小脸参数。
setForeheadShorteningParam:param:	设置缩小额头高度参数。
setMandibleSlimmingParam:param:	设置瘦下颌骨参数。
setNoseLengtheningParam:param:	设置长鼻参数。
enableEyesBrightening:enable:	开启亮眼, 开发者可以调用 [setEyesBrighteningParam] 来设置亮眼参数。
enableLongChin:enable:	开启长下巴功能，可调用 [setLongChinParam] 接口设置长下巴参数。
setEyesBrighteningParam:param:	设置亮眼参数。
setLongChinParam:param:	设置长下巴参数。
setNoseNarrowingParam:param:	设置瘦鼻参数。
setSmallMouthParam:param:	设置小嘴参数。
setTeethWhiteningParam:param:	设置白牙参数。
enableBigEyes:enable:	使用后眼睛会变大。
setBigEyesParam:param:	设置大眼参数。
enableTeethWhitening:enable:	开启后牙齿会变得更白, 可以通过 [setTeethWhiteningParam] 接口设置参数。
setFaceLiftingParam:param:	设置瘦脸参数。
enableFaceLifting:enable:	开启后脸会变得更苗条，下巴更瘦。
enableNoseNarrowing:enable:	开启瘦鼻功能，你可以调用 [setNoseNarrowingParam] 接口来设置参数。
enableSmallMouth:enable:	开启长小嘴功能，可调用 [setSmallMouthParam] 接口设置参数。

美妆

方法名	描述
setBlusher:path:	设置腮红资源，设置 [nil] 默认去除腮红效果。
setBlusherParam:param:	设置腮红参数。
setColoredcontacts:path:	设置美瞳资源，设置 [nil] 默认去除美瞳效果。
setColoredcontactsParam:param:	设置美瞳参数。
setEyeliner:path:	设置眼线资源，设置 [nil] 默认去除眼线效果。
setMakeup:path:	设置风格妆资源，设置 [nil] 默认去除风格妆效果。
setMakeupParam:param:	设置风格妆参数。
setEyelashes:path:	设置眼睫毛资源,设置 [nil] 默认去除眼睫毛效果。
setEyelashesParam:param:	设置眼睫毛参数。
setEyelinerParam:param:	设置眼线参数。
setEyeshadow:path:	设置眼影资源，设置 [nil] 默认去除眼影效果。
setEyeshadowParam:param:	设置眼影参数。
setLipstick:path:	设置口红资源，设置 [nil] 默认去除口红效果。
setLipstickParam:param:	设置口红参数。

背景分割

方法名	描述
enableChromaKey:enable:	开启绿幕分割。
setChromaKeyBackgroundPath:imagePath:mode:	设置绿幕自定义背景路径。
setChromaKeyParam:param:	设置绿幕分割参数。
enableChromaKeyBackground:enable:	开启绿幕分割自定义背景后 SDK 引擎会将绿色作为关键颜色并替换成开发者设置的背景。
enableChromaKeyBackgroundBlur:enable:	开启绿幕分割背景模糊。
enableChromaKeyBackgroundMosaic:enable:	开启绿幕背景马赛克，启动后 SDK 引擎会把绿幕背景会变成马赛克。
enablePortraitSegmentation:enable:	开启 AI 人像分割。
enablePortraitSegmentationBackground:enable:	开启 AI 人像分割自定义背景。
enablePortraitSegmentationBackgroundBlur:enable:	开启 AI 人像分割背景模糊。
enablePortraitSegmentationBackgroundMosaic:enable:	开启 Al 人像分割背景马赛克
setChromaKeyBackgroundBlurParam:param:	设置绿幕背景模糊参数。
setChromaKeyBackgroundBuffer:buffer:mode:	设置绿幕分割自定义背景。
setChromaKeyBackgroundMosaicParam:param:	设置绿幕分割背景马赛克参数。
setChromaKeyForegroundPosition:rect:	设置绿幕分割前景位置。
setPortraitSegmentationBackgroundBlurParam:param:	设置 AI 人像分割背景模糊参数。
setPortraitSegmentationBackgroundBuffer:buffer:mode:	设置 Al 人像分割自定义背景。
setPortraitSegmentationBackgroundMosaicParam:param:	设置 Al 人像分割背景马赛克参数。
setPortraitSegmentationBackgroundPath:imagePath:mode:	设置 AI 人像分割自定义背景路径。
setPortraitSegmentationForegroundPosition:rect:	设置 Al 人像分割前景位置。

人脸检测

方法名	描述
enableFaceDetection:enable:	开启人脸检测。
facedetectionresults:effects:	人脸检测回调。

挂件

方法名	描述
setPendant:path:	设置挂件。

滤镜

方法名	描述
setFilter:path:	设置滤镜资源，设置 [nil] 默认去除滤镜。
setFilterParam:param:	设置滤镜参数。

渲染

方法名	描述
processImageBuffer:buff:	处理图像，该接口需要传入的图片类型为 CVPixelBufferRef 类型。

废弃接口列表

方法名	描述
setModels:modelInfoList:	【已废弃】设置 AI 模型，支持同时设置多个模型。此函数在 1.2.0及以后的版本已废弃，请使用 [setResources] 代替。