Documentation
AI Effects
Function Overview
Function Overview

Function Overview

Last updated：2025-04-07 19:19

ZEGOCLOUD SDK has a comprehensive global network coverage with key regional nodes, offering a rich set of APIs to provide clear and stable AI Effects services across multiple platforms.

Here is a brief introduction to the basic APIs.

Method	Description
create	Creating an Effects instance
getAuthInfo	Gets the SDK's authorized message. send authorized message and appID to apply for authentication file to ZEGO server.
getDeviceLevel	Get the device phone performance level. Deploy before the Effects environment is initialized to obtain the effect capabilities corresponding to device performance.
getVersion	Gets the SDK's version number.
setAdvancedConfig	Effects advanced function switch.
setResources	Set effects static resources.
create	Creating an Effects instance
create	Creating an Effects instance
destroy	Destroy the Effects Object.
setEventHandler	Sets up the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared.
initEnv	Initialize the Effects engine environment
uninitEnv	Uninitializes the Effects engine environment
onError	The callback for obtaining error information.

Beauty

Method	Description
enableAcneRemoving	enable the acne removing function, you can set the acne parameters by calling the [setAcneRemovingParam] interface.
enableClarity	enable the clarity function, you can set the clarity parameters by calling the [setClarityParam] interface.
enableDarkCirclesRemoving	enable the darkcircles removing function, you can set the ruddy parameters by calling the [setDarkCirclesRemovingParam] interface.
enableSkinColor	enable the skin color function
enableWrinklesRemoving	Enable the wrinkles removing function, you can set the wrinkles removing parameters by calling the [setWrinklesRemovingParam] interface.
setAcneRemovingParam	Set acne removing parameters
setClarityParam	Set clarity parameters
setDarkCirclesRemovingParam	Set the darkcircles removing parameters.
setSkinColorParam	Set the skin color parameters.
setSkinColorResPath	Set the skin resource path' parameters.
setWrinklesRemovingParam	Set the wrinkles removing parameters.
enableRosy	enable the ruddy function, you can set the ruddy parameters by calling the [setRosyParam] interface.
enableSharpen	enable the sharpening function, you can call the [setSharpenParam] interface to set the sharpening parameters.
enableSmooth	The function of peeling is enabled, and the [setSmoothParam] interface can be called to set the peeling parameters.
setRosyParam	set rosy parameters.
setSharpenParam	Set the smooth parameters.
setSmoothParam	Set the smooth parameters
enableWhiten	When opened, the skin will become whiter.
setWhitenParam	Set whitening parameters

Beauty

Method	Description
enableCheekboneSlimming	enable the cheekbone slimming function, you can set the cheekbone slimming parameters by calling the [setCheekboneSlimmingParam] interface.
enableFaceShortening	enable the face shortening function, you can set the face shortening parameters by calling the [setFaceShorteningParam] interface.
enableForeheadShortening	enable the forehead shortening function, you can set the forehead shortening parameters by calling the [setForeheadShorteningParam] interface.
enableMandibleSlimming	enable the mandible slimming function, you can set the mandible slimming parameters by calling the [setMandibleSlimmingParam] interface.
enableNoseLengthening	enable the nose lengthening function, you can set the nose lengthening parameters by calling the [setNoseLengtheningParam] interface.
setCheekboneSlimmingParam	Set the cheekbone slimming parameters.
setFaceShorteningParam	Set the face shortening parameters.
setForeheadShorteningParam	Set the forehead shortening parameters.
setMandibleSlimmingParam	Set the mandible slimming parameters.
setNoseLengtheningParam	Set the nose lengthening parameters.
enableEyesBrightening	enable bright eyes, developers can set the bright eyes parameter by calling [seteyesbrighteningParam].
enableLongChin	Long chin function is enabled, and parameters of long chin can be set by calling [SetLongChinParam] interface.
setEyesBrighteningParam	Set the brightness parameters.
setLongChinParam	Set long chin parameters.
setNoseNarrowingParam	Set thin nose parameters.
setSmallMouthParam	Set the small mouth parameters.
setTeethWhiteningParam	Set the white tooth parameters.
enableBigEyes	Eyes will get bigger when enabled
setBigEyesParam	Set the eye enlargement parameters.
enableTeethWhitening	Open the teeth will become more white, you can set some parameters through the [setTeethWhiteningParam] interface.
setFaceLiftingParam	Set the thin face parameters
enableFaceLifting	Turn it on and your face will be slimmer and your chin will be thinner
enableNoseNarrowing	enable the thin nose function, you can call the [setNoseNarrowingParam] interface to set parameters.
enableSmallMouth	To enable the long mouth function, you can call the [SetSmallMouthParam] interface to set the parameters.

Makeups

Method	Description
setBlusher	Set the blusher resource, set [null] to remove the blusher by default.
setBlusherParam	Set blusher parameters.
setColoredcontacts	Set the coloredcontacts resource, set [null] to remove the coloredcontacts by default.
setColoredcontactsParam	Set coloredcontacts parameters.
setEyeliner	Set the eyeliner resource, set [null] to remove the eyeliner by default.
setMakeup	Set the makeup resource, set [null] to remove the makeup by default.
setMakeupParam	Set makeup parameters.
setEyelashes	Set the eyelashes resource, set [null] to remove the eyelashes by default.
setEyelashesParam	Set eyelashes parameters.
setEyelinerParam	Set eyeliner parameters.
setEyeshadow	Set the eyeshadow resource, set [null] to remove the eyeshadow by default.
setEyeshadowParam	Set eyeshadow parameters.
setLipstick	Set up lipstick resources, set [null] to remove the lipstick by default.
setLipstickParam	Set lipstick parameters.

Background segmentation

Method	Description
enableChromaKey	Enable green screen segmentation.
setChromaKeyBackgroundTexture	Set the green screen split custom background.
setChromaKeyBackgroundPath	Set the green screen custom background path.
setChromaKeyParam	Sets the green screen partition parameters
enableChromaKeyBackground	When the green screen custom background is enabled, the SDK engine will use green as the key color and replace it with the background set by the developer.
enableChromaKeyBackgroundBlur	Open the green screen background fuzzy segmentation.
enableChromaKeyBackgroundMosaic	Turn on the green background Mosaic. The SDK engine will turn the green background into a Mosaic after startup.
enablePortraitSegmentation	When AI portrait segmentation is enabled.
enablePortraitSegmentationBackground	Turn on AI Portrait Segmentation Custom Background.
enablePortraitSegmentationBackgroundBlur	Open ai portrait background segmentation fuzzy.
enablePortraitSegmentationBackgroundMosaic	Open the ai portrait background segmentation Mosaic.
setChromaKeyBackgroundBlurParam	Sets the green screen background blur parameter
setChromaKeyBackgroundBuffer	Set the green screen split custom background.
setChromaKeyBackgroundMosaicParam	Set the background mosaic parameters of the green screen segmentation.
setChromaKeyForegroundPosition	Sets the green screen segmentation foreground position.
setPortraitSegmentationBackgroundBlurParam	Set AI portrait segmentation background blur parameters
setPortraitSegmentationBackgroundBuffer	Set up custom backgrounds for AI portrait segmentation
setPortraitSegmentationBackgroundMosaicParam	Sets portrait split background Mosaic parameters
setPortraitSegmentationBackgroundPath	Set custom background path for AI portrait segmentation.
setPortraitSegmentationBackgroundTexture	Set the AI portrait segmentation to customize the background.
setPortraitSegmentationForegroundPosition	Sets the portrait segmentation foreground position.

Face Detection

Method	Description
enableFaceDetection	Turn on face detection
onFaceDetectionResult	Face detection callback.

Pendant

Method	Description
setPendant	Set the pendant.

Filter

Method	Description
setFilter	Set the filter resource, set [null] to remove the filter by default.
setFilterParam	Set filter parameters

Rendering

Method	Description
processImageBufferRGB	To process images, the interface needs to pass in images of type Buffer, which only supports data in the RGB color space.
processImageBufferYUV	To process images, the interface needs to pass in images of type Buffer, which only supports data in the YUV color space.
processTexture	To process images, the interface needs to pass in an image type of Texture.

List of obsolete interfaces

Method	Description
setModels	Set AI model, support multiple models at the same time.

Function Overview

SDK Initialization Related Functions

Beauty

Beauty

Makeups

Background segmentation

Face Detection

Pendant

Filter

Rendering

List of obsolete interfaces