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:appid:appSign:	Creating an Effects instance
getAuthInfo:appSign:	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:config:	Effects advanced function switch.
setResources:resourceInfoList:	Set effects static resources.
create:license:	Creating an Effects instance
create:appid:appSign:callback:	Creating an Effects instance
destroy	Destroy the Effects Object.
setEventHandler:eventHandler:	Sets up the event notification callbacks that need to be handled. If the eventHandler is set to [nil], all the callbacks set previously will be cleared.
initEnv:resolution:	Initialize the Effects engine environment
uninitEnv	Uninitializes the Effects engine environment
effects:errcode:desc:	The callback for obtaining error information.

Beauty

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

Beauty

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

Makeups

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

Background segmentation

Method	Description
enableChromaKey:enable:	Enable green screen segmentation.
setChromaKeyBackgroundPath:imagePath:mode:	Set the green screen custom background path.
setChromaKeyParam:param:	Sets the green screen partition parameters
enableChromaKeyBackground:enable:	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:enable:	Open the green screen background fuzzy segmentation.
enableChromaKeyBackgroundMosaic:enable:	Turn on the green background Mosaic. The SDK engine will turn the green background into a Mosaic after startup.
enablePortraitSegmentation:enable:	When AI portrait segmentation is enabled.
enablePortraitSegmentationBackground:enable:	Turn on AI Portrait Segmentation Custom Background.
enablePortraitSegmentationBackgroundBlur:enable:	Open ai portrait background segmentation fuzzy.
enablePortraitSegmentationBackgroundMosaic:enable:	Open the ai portrait background segmentation Mosaic.
setChromaKeyBackgroundBlurParam:param:	Sets the green screen background blur parameter
setChromaKeyBackgroundBuffer:buffer:mode:	Set the green screen split custom background.
setChromaKeyBackgroundMosaicParam:param:	Set the background mosaic parameters of the green screen segmentation.
setChromaKeyForegroundPosition:rect:	Sets the green screen segmentation foreground position.
setPortraitSegmentationBackgroundBlurParam:param:	Set AI portrait segmentation background blur parameters
setPortraitSegmentationBackgroundBuffer:buffer:mode:	Set up custom backgrounds for AI portrait segmentation
setPortraitSegmentationBackgroundMosaicParam:param:	Sets portrait split background Mosaic parameters
setPortraitSegmentationBackgroundPath:imagePath:mode:	Set custom background path for AI portrait segmentation.
setPortraitSegmentationForegroundPosition:rect:	Sets the portrait segmentation foreground position.

Face Detection

Method	Description
enableFaceDetection:enable:	Turn on face detection
facedetectionresults:effects:	Face detection callback.

Pendant

Method	Description
setPendant:path:	Set the pendant.

Filter

Method	Description
setFilter:path:	Set the filter resource, set [nil] to remove the filter by default.
setFilterParam:param:	Set filter parameters

Rendering

Method	Description
processImageBuffer:buff:	process images, interface needs to pass in an image of type CVPixelBufferRef.

List of obsolete interfaces

Method	Description
setModels:modelInfoList:	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