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

功能总览

更新时间：2024-10-31 19:35

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。

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

初始化相关的前置功能

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

美颜

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

美型

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

美妆

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

背景分割

方法名	描述
enableChromaKey	开启绿幕分割。
setChromaKeyBackgroundTexture	设置绿幕分割自定义背景。
setChromaKeyBackgroundPath	设置绿幕自定义背景路径。
setChromaKeyParam	设置绿幕分割参数。
enableChromaKeyBackground	开启绿幕分割自定义背景后 SDK 引擎会将绿色作为关键颜色并替换成开发者设置的背景。
enableChromaKeyBackgroundBlur	开启绿幕分割背景模糊，启动后可通过 [setChromaKeyBackgroundBlurParam] 设置背景模糊参数。
enableChromaKeyBackgroundMosaic	开启绿幕背景马赛克，启动后 SDK 引擎会把绿幕背景会变成马赛克。
enablePortraitSegmentation	开启 AI 人像分割，启动后 SDK 引擎会把人像进行抠图并把背景alpha通道改成 0，开发者可以通过使用透明的背景来达到在背景播放视频的目的。开发者还可以通过 [enablePortraitSegmentationBackground] [enablePortraitSegmentationBackgroundMosaic] [enablePortraitSegmentationBackgroundBlur] 接口来设置自定义背景或马赛克背景或高斯模糊背景。该功能适用于在背景播放视频或在背景播放ppt等业务场景。
enablePortraitSegmentationBackground	开启 AI 人像分割自定义背景，启动后可通过 [setPortraitSegmentationBackgroundTexture] [setPortraitSegmentationBackgroundPath] [setPortraitSegmentationBackgroundBuffer] 等接口设置自定义背景。 SDK 会将人像抠图，并把人像放在开发者设置的背景图片上。
enablePortraitSegmentationBackgroundBlur	开启 AI 人像分割背景模糊，启动后可通过 [setPortraitSegmentationBackgroundBlurParam] 设置背景模糊参数。
enablePortraitSegmentationBackgroundMosaic	开启 Al 人像分割背景马赛克，启动后可通过 [setPortraitSegmentationBackgroundMosaicParam] 设置马赛克类型。
setChromaKeyBackgroundBlurParam	设置绿幕背景模糊参数。
setChromaKeyBackgroundBuffer	设置绿幕分割自定义背景。
setChromaKeyBackgroundMosaicParam	设置绿幕分割背景马赛克参数。
setChromaKeyForegroundPosition	设置绿幕分割前景位置。
setPortraitSegmentationBackgroundBlurParam	设置 AI 人像分割背景模糊参数。
setPortraitSegmentationBackgroundBuffer	设置 Al 人像分割自定义背景。
setPortraitSegmentationBackgroundMosaicParam	设置 Al 人像分割背景马赛克参数。
setPortraitSegmentationBackgroundPath	设置 AI 人像分割自定义背景路径。
setPortraitSegmentationBackgroundTexture	设置 AI 人像分割自定义背景。
setPortraitSegmentationForegroundPosition	设置 Al 人像分割前景位置。

人脸检测

方法名	描述
enableFaceDetection	开启人脸检测。
onFaceDetectionResult	人脸检测回调。

挂件

方法名	描述
setPendant	设置挂件。

滤镜

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

渲染

方法名	描述
processImageBufferRGB	处理图像，该接口需要传入的图片类型为 Buffer 类型，只支持 RGB 颜色空间的数据。
processImageBufferYUV	处理图像，该接口需要传入的图片类型为 Buffer 类型，只支持 YUV 颜色空间的数据。
processTexture	处理图像，该接口需要传入的图片类型为 texture 类型。

废弃接口列表

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