Release notes

Version 2.2.1

Release Date: 2025-05-19

Bug Fixes

Fix known issues.

Version 2.2.0

Release Date: 2025-04-07

New Features

Feature	Description	Related APIs
Added create synchronous interface	A new create synchronous execution interface is introduced, simplifying code logic and making it easier for users to integrate.	create

Bug Fixes

Fix known issues.

Version 2.1.1

Release Date: 2025-01-13

Bug Fixes

Fix known issues.

Version 2.1.0

Release Date: 2024-12-26

Feature	Description	Related APIs
Optimize online authentication logic	Optimize the online authentication file expiration and caching logic, which is uniformly handled by the SDK without requiring separate user processing.	create

Bug Fixes

Fix known issues.

Deprecated and Deleted

Deprecated API	Change Description	Deprecated Version
create	The original Effects instance creation API create is deprecated and replaced with the same name create API. The API parameters are different, please pay attention when switching.	2.1.0

Version 2.0.2

Release Date: 2024-11-28

Bug Fixes

Fix known issues.

Version 2.0.1

Release Date: 2024-11-19

Bug Fixes

Fix known issues.

Version 2.0.0

Release Date: 2024-10-31

New Features

Feature	Description	Related APIs
New Face beautification feature	Acne and blemish removal (make skin smoother). Clearer portrait. Skin tone enhancement (options include tan, skin tone enhancement, warm white, cool white, and wheat).	enableAcneRemoving, setAcneRemovingParam enableClarity, setClarityParam enableSkinColor, setSkinColorParam, setSkinColorResPath

Improvements

Improvement	Description	Related APIs
Enhanced effects	Improved skin smoothing and skin tone enhancement effects.	-
Stability improvement	Optimized occlusion handling, resulting in more stable display of beauty makeups when hands or objects are blocking the face.	-
Performance optimization	Improved device performance for smoother operation.	getDeviceLevel, setAdvancedConfig

Version 1.4.11

Release Date: 2024-04-24

Improvements

Improvement	Description	Related APIs
Improved Face detection performance	Optimized face model to improve Face detection speed and make Face beautification effects respond faster.	-

Version 1.4.10

Release Date: 2023-12-29

Bug Fixes

Fixed the issue where the background fill mode needed to be set twice to take effect.
Fixed the issue where the ZegoEffectsScaleMode > ZegoEffectsScaleModeScaleToFill setting caused abnormal effects.

Version 1.4.9

Release Date: 2022-06-20

Improvements

Improvement	Description	Related APIs
Improved Background Segmentation	When performing background segmentation, it is now tied to face detection. If no face is detected, the background segmentation result will be hidden and the background image will be displayed directly.	setPortraitSegmentationBackgroundPath setPortraitSegmentationBackgroundBuffer
Improved Face Detection Model	Updated the face detection model to improve detection accuracy.	-

Bug Fixes

Fix known issues.

Version 1.4.7

Release Date: 2022-01-07

New Features

Feature	Description	Related Documentation
Added Server Authentication Interface	Added a public gateway interface for server-side authentication, allowing developers to access and obtain ZegoEffects server through their own server, set authentication capabilities, manage authentication files, and have higher flexibility.	Online Authentication

Improvements

Improvement	Description	Related APIs
Improved Demo App Experience	Updated Stickers resources to support outputting results through the editor. Updated Beauty makeups resources. Updated resource configuration directory. Support parameterized updates for Face shape retouch feature. Support full-screen Skin smoothing effect for Face beautification feature. Support Face beautification, Beauty makeups, Stickers, and other features for two people appearing on the screen at the same time.	Download Demo App

Bug Fixes

Fixed some known issues with the Demo App.

Version 1.4.6

Release Date: 2021-12-20

Improvements

Improvement	Description	Related APIs
Improved AI Models	Updated AI models to improve facial recognition capabilities.	-
Improved Skin Smoothing Effect	Optimized the Skin smoothing effect in the Face beautification feature.	setSmoothParam

Version 1.4.5

Release Date: 2021-11-29

Improvements

Improvement	Description	Related APIs
Improved Portrait Segmentation	Optimized AI models for better fitting of portrait edges and significantly reduced edge jitter.	setResources

Version 1.4.0

Release date: 2021-11-10

New features

Feature	Description	Related API/Doc
Beauty makeup feature added	The following functionalities are supported: Eyeliner Eyelashes Eye shadow Blusher Lipstick Colored eye contacts Makeup looks	setEyeliner, setEyelinerParam setEyelashes, setEyelashesParam setEyeshadow, setEyeshadowParam setBlusher, setBlusherParam setLipstick, setLipstickParam setColoredcontacts, setColoredcontactsParam setMakeup, setMakeupParam
New API for server authentication added	The public gateway interface on the server is added to enable you to access the ZegoEffects Server via your own server, set up the authentication capability, and manage authentication info files, which is more flexible than before.	Online authentication

Feature

Description

Related API/Doc

Beauty makeup feature added

The following functionalities are supported:

Eyeliner
Eyelashes
Eye shadow
Blusher
Lipstick
Colored eye contacts
Makeup looks

New API for server authentication added

The public gateway interface on the server is added to enable you to access the ZegoEffects Server via your own server, set up the authentication capability, and manage authentication info files, which is more flexible than before.

Online authentication

Version 1.3.0

Release date: 2021-10-09

New features

Feature Description Related API

New face beautification features added

Feature	Description	Related API
New face beautification features added	The following features are added: Nasolabial folds removing Dark circles removing	`enableWrinklesRemoving`,`setWrinklesRemovingParam` `enableDarkCirclesRemoving`, `setDarkCirclesRemovingParam`
New face shape retouch features added	The following features are added: Forehead shortening Mandible slimming Cheekbone slimming Face shortening Nose lengthening	`enableForeheadShortening`, `setForeheadShorteningParam` `enableMandibleSlimming`, `setMandibleSlimmingParam` `enableCheekboneSlimming`, `setCheekboneSlimmingParam` `enableFaceShortening`, `setFaceShorteningParam` `enableNoseLengthening`, `setNoseLengtheningParam`

The following features are added:

Nasolabial folds removing
Dark circles removing

enableWrinklesRemoving,setWrinklesRemovingParam
enableDarkCirclesRemoving, setDarkCirclesRemovingParam

New face shape retouch features added

The following features are added:

Forehead shortening
Mandible slimming
Cheekbone slimming
Face shortening
Nose lengthening

enableForeheadShortening, setForeheadShorteningParam
enableMandibleSlimming, setMandibleSlimmingParam
enableCheekboneSlimming, setCheekboneSlimmingParam
enableFaceShortening, setFaceShorteningParam
enableNoseLengthening, setNoseLengtheningParam

API changes

New APIs

New API	Description
`enableWrinklesRemoving`	Enables the nasolabial folds removing feature.
`setWrinklesRemovingParam`	Sets the intensity of the nasolabial folds removing feature.
`enableDarkCirclesRemoving`	Enables the dark circles removing feature.
`setDarkCirclesRemovingParam`	Sets the intensity of the dark circles removing feature.
`enableForeheadShortening`	Enables the forehead shortening feature.
`setForeheadShorteningParam`	Sets the intensity of the forehead shortening feature.
`enableMandibleSlimming`	Enables the mandible sliming feature.
`setMandibleSlimmingParam`	Sets the intensity of the mandible sliming feature.
`enableCheekboneSlimming`	Enables the cheekbone slimming feature.
`setCheekboneSlimmingParam`	Sets the intensity of the cheekbone slimming feature.
`enableFaceShortening`	Enables the face shortening feature.
`setFaceShorteningParam`	Sets the intencisty of the face shortening feature.
`enableNoseLengthening`	Enables the nose lengthening feature.
`setNoseLengtheningParam`	Sets the intensity of the nose lengthening feature.

Version 1.2.0

Release date: 2021-08-31

New features

Feature	Description	Related API
Online privilege authentication feature added	Allows a client accesses the ZegoEffects Server, applies for a license file, and performs network authentication.	`getAuthInfo`

API changes

New API

New API	Description
`getAuthInfo`	Gets the authentication information to request a license file.

Deprecated API

Deprecated API	Description	Version
setModels	The function of importing models implemented by the `setModels` API is merged into the `setResources` API, and models and resources are set uniformly by the `setResources` API.	Deprecated in version 1.2.0

Version 1.1.1

Release date: 2021-07-01

New features

Feature	Description	Related API
Filters	Added various filter effects, which can be used in many different use cases such as short video and live streaming.	`setFilter` `setFilterParam`

Version 1.0.0

Release date: 2021-05-25

The initial release of the ZegoEffects SDK, providing features including face beautification, face shape retouch, face detection, background segmentation, stickers, and more.