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

功能总览

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

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

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

初始化相关的前置功能

方法名	描述
effects_on_error	错误信息回调。
zego_effects_get_auth_info	获取 SDK 授权信息，通过授权信息和 appID 可以向 ZEGO 服务器申请鉴权文件。
zego_effects_get_version	获取 Effects 版本号。
zego_effects_set_advanced_config	Effects 高级功能开关。
zego_effects_set_resources	设置 Effects 静态资源。
zego_effects_create	创建 Effects 实例。
zego_effects_destroy	销毁 Effects 对象。
zego_effects_is_env_inited	effects 环境是否初始化。
zego_effects_init_env	初始化 Effects 引擎环境。
zego_effects_uninit_env	反初始化 Effects 引擎环境。

美颜

方法名	描述
enableAcneRemoving	开启祛痘斑功能，可调用 [setAcneRemovingParam] 接口设置祛痘斑参数。
enableClarity	开启清晰功能，可调用 [setClarityParam] 接口设置清晰参数。
zego_effects_enable_darkcircles_removing	开启黑眼圈去除功能，可调用 [setDarkCirclesRemovingParam] 接口设置黑眼圈去除参数。
enableSkinColor	开启换肤功能
zego_effects_enable_wrinkles_removing	开启法令纹去除功能，可调用 [setWrinklesRemovingParam] 接口设置法令纹去除参数。
setAcneRemovingParam	设置祛痘斑参数。
setClarityParam	设置清晰参数。
zego_effects_set_darkcircles_removing_param	设置黑眼圈去除参数。
setSkinColorParam	设置换肤参数。
setSkinColorResPath	设置换肤资源路径参数。
zego_effects_set_wrinkles_removing_param	设置法令纹去除参数。
zego_effects_enable_rosy	开启红润功能，可调用 [setRosyParam] 接口设置红润参数。
zego_effects_enable_sharpen	开启锐化功能，可调用 [setSharpenParam] 接口设置锐化参数。
zego_effects_enable_smooth	开启磨皮功能，可调用 [setSmoothParam] 接口设置磨皮参数。
zego_effects_set_rosy_param	设置红润参数。
zego_effects_set_sharpen_param	设置锐化参数。
zego_effects_set_smooth_param	设置磨皮参数。
zego_effects_enable_whiten	开启美白功能。
zego_effects_set_whiten_param	设置美白参数。

美型

方法名	描述
zego_effects_enable_cheekbone_slimming	开启瘦颧骨功能，可调用 [setCheekboneSlimmingParam] 接口设置瘦颧骨参数。
zego_effects_enable_face_shortening	开启小脸功能，可调用 [setFaceShorteningParam] 接口设置小脸参数。
zego_effects_enable_forehead_shortening	开启缩小额头高度功能，可调用 [setForeheadShorteningParam] 接口设置缩小额头高度参数。
zego_effects_enable_mandible_slimming	开启瘦下颌骨功能，可调用 [setMandibleSlimmingParam] 接口设置瘦下颌骨参数。
zego_effects_enable_nose_lengthening	开启长鼻功能，可调用 [setNoseLengtheningParam] 接口设置长鼻参数。
zego_effects_set_cheekbone_slimming_param	设置瘦颧骨参数。
zego_effects_set_face_shortening_param	设置小脸参数。
zego_effects_set_forehead_shortening_param	设置缩小额头高度参数。
zego_effects_set_mandible_slimming_param	设置瘦下颌骨参数。
zego_effects_set_nose_lengthening_param	设置长鼻参数。
zego_effects_enable_eyes_brightening	开启亮眼, 开发者可以调用 [setEyesBrighteningParam] 来设置亮眼参数。
zego_effects_enable_long_chin	开启长下巴功能，可调用 [setLongChinParam] 接口设置长下巴参数。
zego_effects_set_eyes_brightening_param	设置亮眼参数。
zego_effects_set_long_chin_param	设置长下巴参数。
zego_effects_set_nose_narrowing_param	设置瘦鼻参数。
zego_effects_set_small_mouth_param	设置小嘴参数。
zego_effects_set_teeth_whitening_param	设置白牙参数。
zego_effects_enable_big_eyes	使用后眼睛会变大。
zego_effects_set_big_eyes_param	设置大眼参数。
zego_effects_enable_teeth_whitening	开启后牙齿会变得更白, 可以通过 [setTeethWhiteningParam] 接口设置参数。
zego_effects_set_face_lifting_param	设置瘦脸参数。
zego_effects_enable_face_lifting	开启后脸会变得更苗条，下巴更瘦。
zego_effects_enable_nose_narrowing	开启瘦鼻功能，你可以调用 [setNoseNarrowingParam] 接口来设置参数。
zego_effects_enable_small_mouth	开启长小嘴功能，可调用 [setSmallMouthParam] 接口设置参数。

美妆

方法名	描述
zego_effects_set_blusher	设置腮红资源，设置 [null] 默认去除腮红效果。
zego_effects_set_blusher_param	设置腮红参数。
zego_effects_set_coloredcontacts	设置美瞳资源，设置 [null] 默认去除美瞳效果。
zego_effects_set_coloredcontacts_param	设置美瞳参数。
zego_effects_set_eyeliner	设置眼线资源，设置 [null] 默认去除眼线效果。
zego_effects_set_makeup	设置风格妆资源，设置 [null] 默认去除风格妆效果。
zego_effects_set_makeup_param	设置风格妆参数。
zego_effects_set_eyelashes	设置眼睫毛资源,设置 [null] 默认去除眼睫毛效果。
zego_effects_set_eyelashes_param	设置眼睫毛参数。
zego_effects_set_eyeliner_param	设置眼线参数。
zego_effects_set_eyeshadow	设置眼影资源，设置 [null] 默认去除眼影效果。
zego_effects_set_eyeshadow_param	设置眼影参数。
zego_effects_set_lipstick	设置口红资源，设置 [null] 默认去除口红效果。
zego_effects_set_lipstick_param	设置口红参数。

背景分割

方法名	描述
zego_effects_enable_chroma_key	开启绿幕分割。
zego_effects_set_chroma_key_background_texture	设置绿幕分割自定义背景。
zego_effects_set_chroma_key_background_path	设置绿幕自定义背景路径。
zego_effects_set_chroma_key_param	设置绿幕分割参数。
zego_effects_enable_chroma_key_background	开启绿幕分割自定义背景后 SDK 引擎会将绿色作为关键颜色并替换成开发者设置的背景。
zego_effects_enable_chroma_key_background_blur	开启绿幕分割背景模糊。
zego_effects_enable_chroma_key_background_mosaic	开启绿幕背景马赛克，启动后 SDK 引擎会把绿幕背景会变成马赛克。
zego_effects_enable_portrait_segmentation	开启 AI 人像分割。
zego_effects_enable_portrait_segmentation_background	开启 AI 人像分割自定义背景。
zego_effects_enable_portrait_segmentation_background_blur	开启 AI 人像分割背景模糊。
zego_effects_enable_portrait_segmentation_background_mosaic	开启 Al 人像分割背景马赛克
zego_effects_set_chroma_key_background_blur_param	设置绿幕背景模糊参数。
zego_effects_set_chroma_key_background_buffer	设置绿幕分割自定义背景。
zego_effects_set_chroma_key_background_mosaic_param	设置绿幕分割背景马赛克参数。
zego_effects_set_chroma_key_foreground_position	设置绿幕分割前景位置。
zego_effects_set_portrait_segmentation_background_blur_param	设置 AI 人像分割背景模糊参数。
zego_effects_set_portrait_segmentation_background_buffer	设置 Al 人像分割自定义背景。
zego_effects_set_portrait_segmentation_background_mosaic_param	设置 Al 人像分割背景马赛克参数。
zego_effects_set_portrait_segmentation_background_path	设置 AI 人像分割自定义背景路径。
zego_effects_set_portrait_segmentation_background_texture	设置 AI 人像分割自定义背景。
zego_effects_set_portrait_segmentation_foreground_position	设置 Al 人像分割前景位置。

人脸检测

方法名	描述
zego_register_face_detection_result_callback	人脸检测回调。
zego_effects_enable_face_detection	开启人脸检测。

挂件

方法名	描述
zego_effects_set_pendant	设置挂件。

滤镜

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

渲染

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

废弃接口列表

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