Documentation
AI Effects
Function Overview
Function Overview

Feature Overview

Last updated：2025-07-03 19:44

The ZEGO SDK has a comprehensive network of nodes covering key areas globally, providing a rich set of APIs for multi-platforms to offer clear and stable real-time voice and video cloud services. Below is a brief introduction to the basic APIs.

Method Name	Description
create	Create a Zego Effects SDK based on authentication. The authentication is handled internally, and users only need to pass the appID and appSign. The creation status is returned, where a status of 0 indicates success, and any other status indicates failure.
destroy	Destroy the Zego Effects SDK instance to release related resources.
enableImageProcessing	Enable or disable custom image processing and effects.
getAuthInfo	Obtain the SDK authorization information. With the authorization information and appID, a license file can be applied for from the ZEGO server.
getResourcesFolder	Get the resource path of the current device.
getVersion	Get the current version of the Effects SDK.
initEnv	Initialize the Zego Effects environment and set the desired resolution.
setResources	Set local materials or models.
setResourcesPath	Set materials or models at a specified path.
uninitEnv	Uninitialize the Zego Effects environment.

Beauty Interface Functions

Method Name	Description
enableAcneRemoving	Enable the acne removal function.
enableBigEyes	Enable the big eye function.
enableCheekboneSlimming	Enable the cheekbone slimming function.
enableDarkCirclesRemoving	Enable the dark circles removal function.
enableChromaKey	Enable the chroma key function.
enableChromaKeyBackground	Enable the chroma key background.
enableChromaKeyBackgroundBlur	Enable the chroma key blurred background function.
enableChromaKeyBackgroundMosaic	Enable the chroma key mosaic background.
enableEyesBrightening	Enable the eye brightening function.
enableFaceDetection	Enable the face detection function.
enableFaceLifting	Enable the face lifting function.
enableFaceShortening	Enable the face shortening function.
enableForeheadShortening	Enable the forehead shortening function.
enableLongChin	Enable the long chin function.
enableMandibleSlimming	Enable the mandible slimming function.
enableNoseLengthening	Enable the nose lengthening function.
enableNoseNarrowing	Enable the nose narrowing function.
enablePortraitSegmentation	Enable or disable the portrait segmentation function.
enablePortraitSegmentationBackground	Enable the portrait segmentation function.
enablePortraitSegmentationBackgroundBlur	Enable the portrait segmentation function and set the background to a blurred effect.
enablePortraitSegmentationBackgroundMosaic	Enable the portrait segmentation function and set the background to a mosaic effect.
enableRosy	Enable the rosy function.
enableSharpen	Enable the sharpening function.
enableSkinColor	Enable the skin color adjustment function.
enableSmallMouth	Enable the small mouth function.
enableSmooth	Enable the smoothing function.
enableTeethWhitening	Enable the teeth whitening function.
enableWhiten	Enable the whitening function.
enableWrinklesRemoving	Enable the wrinkle removal function.
setAcneRemovingParam	Set the parameters for the acne removal function.
setBigEyesParam	Set the parameters for the big eye function.
setBlusher	Set the blush function.
setBlusherParam	Set the parameters for the blush function.
setBlusherPath	Set the blush function using an absolute resource path.
setCheekboneSlimmingParam	Set the parameters for the cheekbone slimming function.
setClarityParam	Set the parameters for the clarity function.
setChromaKeyBackgroundBlurParam	Set the parameters for the chroma key blurred background.
setChromaKeyBackgroundMosaicParam	Set the parameters for the chroma key mosaic background.
setChromaKeyBackgroundPath	Set the path for the custom chroma key background.
setChromaKeyForegroundPosition	Set the position and size of the chroma key foreground.
setChromaKeyParam	Set the parameters for the chroma key function.
setColoredcontacts	Set the colored contact lenses function.
setColoredcontactsParam	Set the parameters for the colored contact lenses function.
setColoredcontactsPath	Set the colored contact lenses function using an absolute resource path.
setDarkCirclesRemovingParam	Set the parameters for the dark circles removal function.
setEyesBrighteningParam	Set the parameters for the eye brightening function.
setEyelashes	Set the eyelashes function.
setEyelashesParam	Set the parameters for the eyelashes function.
setEyelashesPath	Set the eyelashes function using an absolute resource path.
setEyeliner	Set the eyeliner function.
setEyelinerParam	Set the parameters for the eyeliner function.
setEyelinerPath	Set the eyeliner function using an absolute resource path.
setEyeshadow	Set the eyeshadow function.
setEyeshadowParam	Set the parameters for the eyeshadow function.
setEyeshadowPath	Set the eyeshadow function using an absolute resource path.
setFaceLiftingParam	Set the parameters for the face lifting function.
setFaceShorteningParam	Set the parameters for the face shortening function.
setFilter	Set the filter function.
setFilterParam	Set the parameters for the filter function.
setFilterPath	Set the filter function using an absolute resource path.
setForeheadShorteningParam	Set the parameters for the forehead shortening function.
setLipstick	Set the lipstick function.
setLipstickParam	Set the parameters for the lipstick function.
setLipstickPath	Set the lipstick function using an absolute resource path.
setLongChinParam	Set the parameters for the long chin function.
setMakeup	Set the makeup function.
setMakeupParam	Set the parameters for the makeup function.
setMakeupPath	Set the makeup function using an absolute resource path.
setMandibleSlimmingParam	Set the parameters for the mandible slimming function.
setNoseLengtheningParam	Set the parameters for the nose lengthening function.
setNoseNarrowingParam	Set the parameters for the nose narrowing function.
setPendant	Set the pendant resource.
setPendantPath	Set the pendant resource at a specified path.
setPortraitSegmentationBackgroundBlurParam	Set the parameters for the portrait segmentation background blur effect.
setPortraitSegmentationBackgroundMosaicParam	Set the parameters for the portrait segmentation background mosaic effect.
setPortraitSegmentationBackgroundPath	Set the path for the custom background image of portrait segmentation.
setPortraitSegmentationForegroundPosition	Set the position and size of the portrait segmentation foreground.
setRosyParam	Set the parameters for the rosy function.
setSharpenParam	Set the parameters for the sharpening function.
setSkinColor	Set the skin color adjustment function.
setSkinColorParam	Set the parameters for the skin color adjustment function.
setSmallMouthParam	Set the parameters for the small mouth function.
setSmoothParam	Set the parameters for the smoothing function.
setTeethWhiteningParam	Set the parameters for the teeth whitening function.
setWhitenParam	Set the parameters for the whitening function.
setWrinklesRemovingParam	Set the parameters for the wrinkle removal function.

Feature Overview

Initialization-related Preparatory Functions

Beauty Interface Functions