Class


ZegoEffects	ZegoEffectsAdvancedConfig
ZegoEffectsBigEyesParam	ZegoEffectsBlurParam
ZegoEffectsBlusherParam	ZegoEffectsCheekboneSlimmingParam
ZegoEffectsCheekParam	ZegoEffectsChromaKeyParam
ZegoEffectsColoredcontactsParam	ZegoEffectsDarkCirclesRemovingParam
ZegoEffectsEyelashesParam	ZegoEffectsEyelinerParam
ZegoEffectsEyesBrighteningParam	ZegoEffectsEyeshadowParam
ZegoEffectsFaceDetectionResult	ZegoEffectsFaceLiftingParam
ZegoEffectsFaceShorteningParam	ZegoEffectsFilterParam
ZegoEffectsForeheadShorteningParam	ZegoEffectsLipstickParam
ZegoEffectsLongChinParam	ZegoEffectsMakeupParam
ZegoEffectsMandibleSlimmingParam	ZegoEffectsMosaicParam
ZegoEffectsNoseLengtheningParam	ZegoEffectsNoseNarrowingParam
ZegoEffectsRosyParam	ZegoEffectsSharpenParam
ZegoEffectsSmallMouthParam	ZegoEffectsSmoothParam
ZegoEffectsTeethWhiteningParam	ZegoEffectsVideoFrameParam
ZegoEffectsWhitenParam	ZegoEffectsWrinklesRemovingParam

ZegoEffects

AI Effect function

Details

AI Effect function

Methods

getAuthInfo

static

getAuthInfo

getAuthInfo(info: char** , appSign: string, context: Context): string

Gets the SDK's authorized message. send authorized message and appID to apply for authentication file to ZEGO server.

Parameters

Name	Type	Description
info	char**	AuthorizedInfo.
appSign	string	appSign.
context	Context	context.

Details

Gets the SDK's authorized message. send authorized message and appID to apply for authentication file to ZEGO server.

Return

authorizedInfo.

getVersion

static

getVersion

getVersion(): string

Gets the SDK's version number.

When the SDK is running, the developer finds that it does not match the expected situation and submits the problem and related logs to the ZEGO technical staff for locating. The ZEGO technical staff may need the information of the SDK version to assist in locating the problem. Developers can also collect this information as the version information of the SDK used by the app, so that the SDK corresponding to each version of the app.

SDK version.

setAdvancedConfig

static

setAdvancedConfig

setAdvancedConfig(config: ZegoEffectsAdvancedConfig): void

Effects advanced function switch.

Parameters

Name	Type	Description
config	ZegoEffectsAdvancedConfig	effects Advanced configuration. Such as Render-Mode, Device-Performance-Level, etc.

When to call: Before you create the engine.

setResources

static

setResources

setResources(resourceInfoList: string[]): void

Set effects static resources.

Parameters

Name	Type	Description
resourceInfoList	string[]	Resource list.

Details

This function is required to set up the static resources when the [enableWhiten] [enableTeethWhitening] [setPendant] interface is called. Support setting multiple resource paths at the same time. This must be set before the Effects instance is created.

create

static

create

create(license: string, context: Context): ZegoEffects

Creating an Effects instance

Parameters

Name	Type	Description
license	string	Authentication certificate file.
context	Context	Context.

Details

You need to create and initialize an Effects instance before calling any other function; The SDK supports the creation of multiple ZegoEffects instances.

Return

The ZegoEffects instance object.

enableAcneRemoving

enableAcneRemoving(enable: boolean): ZegoEffects

enable the acne removing function, you can set the acne parameters by calling the [setAcneRemovingParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the acne function; [true] means turning on the function, and vice versa; Default value is [false].

Details

enable the acne removing function, you can set the acne parameters by calling the [setAcneRemovingParam] interface.

enableCheekboneSlimming

enableCheekboneSlimming(enable: boolean): ZegoEffects

enable the cheekbone slimming function, you can set the cheekbone slimming parameters by calling the [setCheekboneSlimmingParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the thin cheekbones function; [true] means to activate the thin cheekbones function; [false] means to turn off the thin cheekbones function.

Details

enable the cheekbone slimming function, you can set the cheekbone slimming parameters by calling the [setCheekboneSlimmingParam] interface.

enableClarity

enableClarity(enable: boolean): ZegoEffects

enable the clarity function, you can set the clarity parameters by calling the [setClarityParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the clarity function; [true] means turning on the function, and vice versa; Default value is [false].

Details

enable the clarity function, you can set the clarity parameters by calling the [setClarityParam] interface.

enableDarkCirclesRemoving

enableDarkCirclesRemoving(enable: boolean): ZegoEffects

enable the darkcircles removing function, you can set the ruddy parameters by calling the [setDarkCirclesRemovingParam] interface.

Parameters

Name	Type	Description
enable	boolean	enable the darkcircles removing function, you can set the darkcircles removing parameters by calling the [setDarkCirclesRemovingParam] interface.

Details

enable the darkcircles removing function, you can set the ruddy parameters by calling the [setDarkCirclesRemovingParam] interface.

enableFaceShortening

enableFaceShortening(enable: boolean): ZegoEffects

enable the face shortening function, you can set the face shortening parameters by calling the [setFaceShorteningParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the small face function; [true] means to activate the small face function; [false] means to turn off the small face function.

Details

enable the face shortening function, you can set the face shortening parameters by calling the [setFaceShorteningParam] interface.

enableForeheadShortening

enableForeheadShortening(enable: boolean): ZegoEffects

enable the forehead shortening function, you can set the forehead shortening parameters by calling the [setForeheadShorteningParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to enable forehead height reduction function; [true] means to enable forehead height reduction function; [false] means to disable forehead height reduction function.

Details

enable the forehead shortening function, you can set the forehead shortening parameters by calling the [setForeheadShorteningParam] interface.

Return

ZegoEffects

enableImageProcessing

enableImageProcessing(enable: boolean): void

Bind the current Effects object to Express's custom rendering process.

Parameters

Name	Type	Description
enable	boolean	rue: Bind the Effects object to the Express custom rendering process. false: Unbind the Effects object to the Express custom rendering process.

Details

Supported version: v1.0.0

Detailed description: Bind the current Effects object to the custom rendering process of Express.

Business scenario: Describe the scenario in which the method/function is used. If there are too many scenarios, you can focus on typical scenarios.

Call timing/notification timing: Call the function after creating the Effects object.

enableMandibleSlimming

enableMandibleSlimming(enable: boolean): ZegoEffects

enable the mandible slimming function, you can set the mandible slimming parameters by calling the [setMandibleSlimmingParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to enable the thin mandible function; [true] means to start the thin mandible function; [false] means to close the thin mandible function.

Details

enable the mandible slimming function, you can set the mandible slimming parameters by calling the [setMandibleSlimmingParam] interface.

enableNoseLengthening

enableNoseLengthening(enable: boolean): ZegoEffects

enable the nose lengthening function, you can set the nose lengthening parameters by calling the [setNoseLengtheningParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to enable the proboscis function; [true] means to enable the proboscis function; [false] means to disable the proboscis function.

Details

enable the nose lengthening function, you can set the nose lengthening parameters by calling the [setNoseLengtheningParam] interface.

Return

ZegoEffects

enableSkinColor

enableSkinColor(enable: boolean): ZegoEffects

enable the skin color function

Parameters

Name	Type	Description
enable	boolean	Whether to activate the skin color function; [true] means turning on the function, and vice versa; Default value is [false].

Details

enable the skin color function, you can set that parameters by calling the [setSkinColorParam] interface, and set skin style resource by calling the [setSkinColorResPath].

enableWrinklesRemoving

enableWrinklesRemoving(enable: boolean): ZegoEffects

Enable the wrinkles removing function, you can set the wrinkles removing parameters by calling the [setWrinklesRemovingParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the function of removing dark circles; [true] means to activate the function of removing dark circles; [false] means to disable the function of removing dark circles.

Details

Enable the wrinkles removing function, you can set the wrinkles removing parameters by calling the [setWrinklesRemovingParam] interface.

getDeviceLevel

getDeviceLevel(): ZegoEffectsDeviceLevel

Get the device phone performance level. Deploy before the Effects environment is initialized to obtain the effect capabilities corresponding to device performance.<br/>

Device leve enumeratioln, corresponding integer number.

setAcneRemovingParam

setAcneRemovingParam(param: ZegoEffectsAcneRemovingParam): ZegoEffects

Set acne removing parameters

Parameters

Name	Type	Description
param	ZegoEffectsAcneRemovingParam	the acne removing parameters.

Details

Set acne removing parameters.

setBlusher

setBlusher(path?: string): ZegoEffects

Set the blusher resource, set [null] to remove the blusher by default.

Parameters

Name	Type	Description
path	string	The absolute path of the blusher resource.

Details

developers can call [setBlusherParam] to set the blusher parameters. When the corresponding blusher source is set, the beauty blusher function will be automatically activated.

Available since: 1.4.0.

setBlusherParam

setBlusherParam(param: ZegoEffectsBlusherParam): ZegoEffects

Set blusher parameters.

Parameters

Name	Type	Description
param	ZegoEffectsBlusherParam	blusher parameters.

Details

Set blusher parameters.

setCheekboneSlimmingParam

setCheekboneSlimmingParam(param: ZegoEffectsCheekboneSlimmingParam): ZegoEffects

Set the cheekbone slimming parameters.

Parameters

Name	Type	Description
param	ZegoEffectsCheekboneSlimmingParam	Functional parameters of thin cheekbones.

Details

Set the cheekbone slimming parameters.

setClarityParam

setClarityParam(param: ZegoEffectsClarityParam): ZegoEffects

Set clarity parameters

Parameters

Name	Type	Description
param	ZegoEffectsClarityParam	the clarity parameters.

Details

Set clarity parameters

setColoredcontacts

setColoredcontacts(path?: string): void

Set the coloredcontacts resource, set [null] to remove the coloredcontacts by default.

Parameters

Name	Type	Description
path	string	Absolute path of coloredcontacts resources.

Details

developers can call [setColoredcontactsParam] to set coloredcontacts parameters. When the corresponding coloredcontacts resources are set, the beauty coloredcontacts function will be automatically activated.

Available since: 1.4.0.

setColoredcontactsParam

setColoredcontactsParam(param: ZegoEffectsColoredcontactsParam): ZegoEffects

Set coloredcontacts parameters.

Parameters

Name	Type	Description
param	ZegoEffectsColoredcontactsParam	coloredcontacts parameters.

Details

Set coloredcontacts parameters.

setDarkCirclesRemovingParam

setDarkCirclesRemovingParam(param: ZegoEffectsDarkCirclesRemovingParam): ZegoEffects

Set the darkcircles removing parameters.

Parameters

Name	Type	Description
param	ZegoEffectsDarkCirclesRemovingParam	Remove dark circles function parameters.

Details

Set the darkcircles removing parameters.

setEyeliner

setEyeliner(path?: string): ZegoEffects

Set the eyeliner resource, set [null] to remove the eyeliner by default.

Parameters

Name	Type	Description
path	string	The absolute path of the eyeliner resource.

Details

developers can call [setEyelinerParam] to set the eyeliner parameters. When the corresponding eyeliner source is set, the beauty eyeliner function will be automatically activated.

Available since: 1.4.0.

setFaceShorteningParam

setFaceShorteningParam(param: ZegoEffectsFaceShorteningParam): ZegoEffects

Set the face shortening parameters.

Parameters

Name	Type	Description
param	ZegoEffectsFaceShorteningParam	Small face function parameters.

Details

Set the face shortening parameters.

setForeheadShorteningParam

setForeheadShorteningParam(param: ZegoEffectsForeheadShorteningParam): ZegoEffects

Set the forehead shortening parameters.

Parameters

Name	Type	Description
param	ZegoEffectsForeheadShorteningParam	Reduce forehead height function parameters.

Details

Set the forehead shortening parameters.

setMakeup

setMakeup(path?: string): ZegoEffects

Set the makeup resource, set [null] to remove the makeup by default.

Parameters

Name	Type	Description
path	string	The absolute path of the makeup resource.

Details

developers can call [setMakeupParam] to set the makeup parameters. When the corresponding makeup resource is set, the beauty makeup function will be automatically activated.

Available since: 1.4.0.

setMakeupParam

setMakeupParam(param: ZegoEffectsMakeupParam): ZegoEffects

Set makeup parameters.

Parameters

Name	Type	Description
param	ZegoEffectsMakeupParam	makeup parameters.

Details

Set makeup parameters.

setMandibleSlimmingParam

setMandibleSlimmingParam(param: ZegoEffectsMandibleSlimmingParam): ZegoEffects

Set the mandible slimming parameters.

Parameters

Name	Type	Description
param	ZegoEffectsMandibleSlimmingParam	Thin mandible parameters.

Details

Set the mandible slimming parameters.

setNoseLengtheningParam

setNoseLengtheningParam(param: ZegoEffectsNoseLengtheningParam): ZegoEffects

Set the nose lengthening parameters.

Parameters

Name	Type	Description
param	ZegoEffectsNoseLengtheningParam	noselengthening parameters.

Details

Set the nose lengthening parameters.

setSkinColorParam

setSkinColorParam(param: ZegoEffectsSkinColorParam): ZegoEffects

Set the skin color parameters.

Parameters

Name	Type	Description
param	ZegoEffectsSkinColorParam	the skin color strengthen parameters.

Details

Set the skin color parameters.

setSkinColorResPath

setSkinColorResPath(bundlePath: string): ZegoEffects

Set the skin resource path' parameters.

Parameters

Name	Type	Description
bundlePath	string	the skin color resource path' parameters.

Details

When using a custom skin color function, you need to call [enableSkinColor] enable skin resource after the skin color of interface Settings to take effect.

setWrinklesRemovingParam

setWrinklesRemovingParam(param: ZegoEffectsWrinklesRemovingParam): ZegoEffects

Set the wrinkles removing parameters.

Parameters

Name	Type	Description
param	ZegoEffectsWrinklesRemovingParam	Remove dark circles function parameters.

Details

Set the wrinkles removing parameters.

destroy

destroy(): void

Destroy the Effects Object.

Used to release resources used by the SDK.

enableEyesBrightening

enableEyesBrightening(enable: boolean): ZegoEffects

enable bright eyes, developers can set the bright eyes parameter by calling [seteyesbrighteningParam].

Parameters

Name	Type	Description
enable	boolean	Whether to enable the eye brightening feature; [true] indicates that the eye brightening feature is enabled; [false] indicates that the eye brightening feature is disabled. The default value is [false].

Details

enable bright eyes, developers can set the bright eyes parameter by calling [seteyesbrighteningParam].

enableLongChin

enableLongChin(enable: boolean): ZegoEffects

Long chin function is enabled, and parameters of long chin can be set by calling [SetLongChinParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to start the longchin function; [true] means start the longchin function; [false] means close the longchin function.

Details

Long chin function is enabled, and parameters of long chin can be set by calling [SetLongChinParam] interface.

enableRosy

enableRosy(enable: boolean): ZegoEffects

enable the ruddy function, you can set the ruddy parameters by calling the [setRosyParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to enable the rosy cheeks feature; [true] means the rosy cheeks feature is activated; [false] means the rosy cheeks feature is turned off. The default value is [false].

Details

enable the ruddy function, you can set the ruddy parameters by calling the [setRosyParam] interface.

enableSharpen

enableSharpen(enable: boolean): ZegoEffects

enable the sharpening function, you can call the [setSharpenParam] interface to set the sharpening parameters.

Parameters

Name	Type	Description
enable	boolean	Whether to enable the sharpening function; [true] indicates that the sharpening function is enabled; [false] indicates that the sharpening function is disabled. The default value is [false].

Details

enable the sharpening function, you can call the [setSharpenParam] interface to set the sharpening parameters.

enableSmooth

enableSmooth(enable: boolean): ZegoEffects

The function of peeling is enabled, and the [setSmoothParam] interface can be called to set the peeling parameters.

Parameters

Name	Type	Description
enable	boolean	Whether to start the microdermabrasion function; [true] means start the microdermabrasion function; [false] means close the microdermabrasion function.

Details

The function of peeling is enabled, and the [setSmoothParam] interface can be called to set the peeling parameters.

setEyelashes

setEyelashes(path?: string): ZegoEffects

Set the eyelashes resource, set [null] to remove the eyelashes by default.

Parameters

Name	Type	Description
path	string	Absolute path of eyelashes resources.

Details

developers can call [setEyelashesParam] to set eyelashes parameters. When the corresponding eyelashes resources are set, the beauty eyelashes function will be automatically activated.

Available since: 1.4.0.

setEyelashesParam

setEyelashesParam(param: ZegoEffectsEyelashesParam): ZegoEffects

Set eyelashes parameters.

Parameters

Name	Type	Description
param	ZegoEffectsEyelashesParam	Eyelashes parameters.

Details

Set eyelashes parameters.

setEyelinerParam

setEyelinerParam(param: ZegoEffectsEyelinerParam): ZegoEffects

Set eyeliner parameters.

Parameters

Name	Type	Description
param	ZegoEffectsEyelinerParam	Eyeliner parameters.

Details

Set eyeliner parameters.

setEyesBrighteningParam

setEyesBrighteningParam(param: ZegoEffectsEyesBrighteningParam): ZegoEffects

Set the brightness parameters.

Parameters

Name	Type	Description
param	ZegoEffectsEyesBrighteningParam	Set the brightness parameters.

Details

Set the brightness parameters.

setEyeshadow

setEyeshadow(path?: string): ZegoEffects

Set the eyeshadow resource, set [null] to remove the eyeshadow by default.

Parameters

Name	Type	Description
path	string	The absolute path of the eye shadow resource.

Details

developers can call [setEyeshadowParam] to set the eye shadow parameters. When the corresponding eye shadow source is set, the beauty eye shadow function will be automatically activated.

Available since: 1.4.0.

setEyeshadowParam

setEyeshadowParam(param: ZegoEffectsEyeshadowParam): ZegoEffects

Set eyeshadow parameters.

Parameters

Name	Type	Description
param	ZegoEffectsEyeshadowParam	Eye shadow parameters.

Details

Set eyeshadow parameters.

setFilter

setFilter(path?: string): ZegoEffects

Set the filter resource, set [null] to remove the filter by default.

Parameters

Name	Type	Description
path	string	The absolute path of the filter resource.

Details

developers can call [setFilterParam] to set the filter parameters. When the corresponding filter source is set, the beauty filter function will be automatically activated.

Available since: 1.1.0

setFilterParam

setFilterParam(param: ZegoEffectsFilterParam): ZegoEffects

Set filter parameters

Parameters

Name	Type	Description
param	ZegoEffectsFilterParam	Filter function parameters.

Details

Set filter parameters

setLipstick

setLipstick(path?: string): ZegoEffects

Set up lipstick resources, set [null] to remove the lipstick by default.

Parameters

Name	Type	Description
path	string	Absolute path of lipstick resources.

Details

developers can call [setLipstickParam] to set lipstick parameters. When the corresponding lipstick resource is set, the beauty lipstick function will be automatically activated.

Available since: 1.4.0.

setLipstickParam

setLipstickParam(param: ZegoEffectsLipstickParam): ZegoEffects

Set lipstick parameters.

Parameters

Name	Type	Description
param	ZegoEffectsLipstickParam	Lipstick parameters.

Details

Set lipstick parameters.

setLongChinParam

setLongChinParam(param: ZegoEffectsLongChinParam): ZegoEffects

Set long chin parameters.

Parameters

Name	Type	Description
param	ZegoEffectsLongChinParam	Set long chin parameters.

Details

Set long chin parameters.

setNoseNarrowingParam

setNoseNarrowingParam(param: ZegoEffectsNoseNarrowingParam): ZegoEffects

Set thin nose parameters.

Parameters

Name	Type	Description
param	ZegoEffectsNoseNarrowingParam	Nose slimming parameters.

Details

Set thin nose parameters.

setRosyParam

setRosyParam(param: ZegoEffectsRosyParam): ZegoEffects

set rosy parameters.

Parameters

Name	Type	Description
param	ZegoEffectsRosyParam	Rosy cheeks function parameters.

Details

set rosy parameters.

setSharpenParam

setSharpenParam(param: ZegoEffectsSharpenParam): ZegoEffects

Set the smooth parameters.

Parameters

Name	Type	Description
param	ZegoEffectsSharpenParam	The parameter of sharpen.

Details

Set the smooth parameters.

setSmallMouthParam

setSmallMouthParam(param: ZegoEffectsSmallMouthParam): ZegoEffects

Set the small mouth parameters.

Parameters

Name	Type	Description
param	ZegoEffectsSmallMouthParam	"Small mouth function parameters."

Details

Set the small mouth parameters.

setSmoothParam

setSmoothParam(param: ZegoEffectsSmoothParam): ZegoEffects

Set the smooth parameters

Parameters

Name	Type	Description
param	ZegoEffectsSmoothParam	Skin smoothing function parameters.

Details

Set the smooth parameters

setTeethWhiteningParam

setTeethWhiteningParam(param: ZegoEffectsTeethWhiteningParam): ZegoEffects

Set the white tooth parameters.

Parameters

Name	Type	Description
param	ZegoEffectsTeethWhiteningParam	Teeth whitening function parameters.

Details

Set the white tooth parameters.

enableBigEyes

enableBigEyes(enable: boolean): ZegoEffects

Eyes will get bigger when enabled

Parameters

Name	Type	Description
enable	boolean	Whether to activate the eye enlargement feature; [true] means the eye enlargement feature is activated; [false] means the eye enlargement feature is deactivated. The default value is [false].

Details

Eyes will get bigger when enabled

setBigEyesParam

setBigEyesParam(param: ZegoEffectsBigEyesParam): ZegoEffects

Set the eye enlargement parameters.

Parameters

Name	Type	Description
param	ZegoEffectsBigEyesParam	The eye enlargement parameter

Details

Set the eye enlargement parameter

enableTeethWhitening

enableTeethWhitening(enable: boolean): ZegoEffects

Open the teeth will become more white, you can set some parameters through the [setTeethWhiteningParam] interface.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the teeth whitening function; [true] means the teeth whitening function is activated; [false] means the teeth whitening function is deactivated. The default value is [false].

Details

Open the teeth will become more white, you can set some parameters through the [setTeethWhiteningParam] interface.

enableWhiten

enableWhiten(enable: boolean): ZegoEffects

When opened, the skin will become whiter.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the skin whitening function; [true] indicates that the skin whitening function is activated; [false] indicates that the skin whitening function is deactivated. The default value is [false].

Details

When opened, the skin will become whiter.

setWhitenParam

setWhitenParam(param: ZegoEffectsWhitenParam): ZegoEffects

Set whitening parameters

Parameters

Name	Type	Description
param	ZegoEffectsWhitenParam	whitening parameters

Details

Set whitening parameters

initEnv

initEnv(width: number, height: number, resolution: CGSize): void

Initialize the Effects engine environment

Parameters

Name	Type	Description
width	number	width of picture.
height	number	Height of the picture.
resolution	CGSize	Picture resolution.

Details

This interface needs to be called to initialize the Effects engine environment before processing image or video data. During the first initialization, if any AI-related function is used, this interface will take time. Please do not call this interface on the main thread, otherwise it will cause the UI thread to stall.

setFaceLiftingParam

setFaceLiftingParam(param: ZegoEffectsFaceLiftingParam): ZegoEffects

Set the thin face parameters

Parameters

Name	Type	Description
param	ZegoEffectsFaceLiftingParam	The thin face parameters

Details

Set the thin face parameters

uninitEnv

uninitEnv(): void

Uninitializes the Effects engine environment

When you stop using the camera to capture, you can call this interface to de-initialize the effects engine environment. De-initialization will release some resource-consuming threads and memory inside the engine. In addition, the loaded ai model and static resources will not be released after de-initialization. The SDK will only be released when the SDK is destroyed, so when initEnv is used again next time, it will not be time-consuming due to model loading.

enableChromaKey

enableChromaKey(enable: boolean): ZegoEffects

Enable green screen segmentation.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the green screen segmentation function; [true] means the green screen segmentation function is activated; [false] means the green screen function is deactivated. The default value is [false].

Details

After starting green screen segmentation, the engine will take green as the key color, and conduct image matting for colors other than green. Developers can use [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] [enableChromaKeyBackgroundMosaic] interface to modify the green curtain custom background.

setChromaKeyBackgroundPath

setChromaKeyBackgroundPath(imagePath: string, mode: ZegoEffectsScaleMode): ZegoEffects

Set the green screen custom background path.

Parameters

Name	Type	Description
imagePath	string	Image path.
mode	ZegoEffectsScaleMode	View mode.

Details

When using a custom background, you need to call [enableChromaKeyBackground] enable custom background after the background of interface Settings to take effect.

setChromaKeyParam

setChromaKeyParam(param: ZegoEffectsChromaKeyParam): ZegoEffects

Sets the green screen partition parameters

Parameters

Name	Type	Description
param	ZegoEffectsChromaKeyParam	Green screen segmentation function parameters.

Details

Developers can adjust green screen tolerance, key colors and other parameters through this interface.

enableChromaKeyBackground

enableChromaKeyBackground(enable: boolean): ZegoEffects

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.

Parameters

Name	Type	Description
enable	boolean

Details

Developers can also through [setChromaKeyBackgroundBuffer] [setChromaKeyBackgroundPath] [setChromaKeyBackgroundTexture] set up green screen custom background。 [enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] the interface can only start one, Each of these enable will overwrite the previous function.

enableChromaKeyBackgroundBlur

enableChromaKeyBackgroundBlur(enable: boolean): ZegoEffects

Open the green screen background fuzzy segmentation.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the green screen background segmentation feature; [true] indicates that the green screen background segmentation feature is enabled; [false] indicates that the green screen background segmentation feature is disabled. The default value is [false].

Details

Open the green screen background fuzzy segmentation, starts fuzzy parameter can be set up by [setChromaKeyBackgroundBlurParam] background.

enableChromaKeyBackgroundMosaic

enableChromaKeyBackgroundMosaic(enable: boolean): ZegoEffects

Turn on the green background Mosaic. The SDK engine will turn the green background into a Mosaic after startup.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the green screen background mosaic function; [true] means the green screen background mosaic function is activated; [false] means the green screen background mosaic function is deactivated. The default value is [false].

Details

Developers can also through[setChromaKeyBackgroundMosaicParam] setting green Mosaic parameters. [enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] the interface can only start one, Each of these enable will overwrite the previous function.

enablePortraitSegmentation

enablePortraitSegmentation(enable: boolean): ZegoEffects

When AI portrait segmentation is enabled.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the portrait segmentation function; [true] indicates that the portrait segmentation function is activated; [false] indicates that the portrait segmentation function is deactivated. The default value is [false].

Details

When AI portrait segmentation is enabled, the SDK engine will cut out the portrait and change the background alpha channel to 0. Developers can play videos in the background by using a transparent background. Developers can also through [enablePortraitSegmentationBackground] [enablePortraitSegmentationBackgroundMosaic] [enablePortraitSegmentationBackgroundBlur] interface to set a custom background or Mosaic or gaussian blur the background. This function is suitable for business scenarios such as playing video in the background or playing PPT in the background.

enablePortraitSegmentationBackground

enablePortraitSegmentationBackground(enable: boolean): ZegoEffects

Turn on AI Portrait Segmentation Custom Background.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the AI portrait segmentation custom background feature; [true] means the AI portrait segmentation custom background feature is enabled; [false] means the AI portrait segmentation custom background feature is disabled. The default value is [false].

Details

Turn on AI Portrait Segmentation Custom Background, When activated by [setPortraitSegmentationBackgroundTexture] [setPortraitSegmentationBackgroundPath] [setPortraitSegmentationBackgroundBuffer] interface Settings such as custom background. The SDK will cut out the portrait image and place the portrait on the background image set by the developer.

enablePortraitSegmentationBackgroundBlur

enablePortraitSegmentationBackgroundBlur(enable: boolean): ZegoEffects

Open ai portrait background segmentation fuzzy.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the portrait segmentation background blur feature; [true] means the portrait segmentation background blur feature is enabled; [false] means the portrait segmentation background blur feature is disabled. The default value is [false].

Details

Open ai portrait background segmentation fuzzy, start after fuzzy parameter can be set up by [setPortraitSegmentationBackgroundBlurParam] background.

enablePortraitSegmentationBackgroundMosaic

enablePortraitSegmentationBackgroundMosaic(enable: boolean): ZegoEffects

Open the ai portrait background segmentation Mosaic.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the portrait segmentation background mosaic feature; [true] indicates that the portrait segmentation background mosaic feature is enabled; [false] indicates that the portrait segmentation background mosaic feature is disabled. The default value is [false].

Details

Open the ai portrait background segmentation Mosaic, starts can be set up by [setPortraitSegmentationBackgroundMosaicParam] Mosaic type.

setChromaKeyBackgroundBlurParam

setChromaKeyBackgroundBlurParam(param: ZegoEffectsBlurParam): ZegoEffects

Sets the green screen background blur parameter

Parameters

Name	Type	Description
param	ZegoEffectsBlurParam	Green Screen Background Blur Function Parameters.

Details

When using background blur, you need to call [enableChromaKeyBackgroundBlur] enable background blur the background of interface Settings to take effect.

setChromaKeyBackgroundMosaicParam

setChromaKeyBackgroundMosaicParam(param: ZegoEffectsMosaicParam): ZegoEffects

Set the background mosaic parameters of the green screen segmentation.

Parameters

Name	Type	Description
param	ZegoEffectsMosaicParam	Mosaic parameters.

Details

You need to call [enableChromaKeyBackgroundMosaic] enable background Mosaic after the background of interface Settings to take effect.

setPortraitSegmentationBackgroundBlurParam

setPortraitSegmentationBackgroundBlurParam(param: ZegoEffectsBlurParam): ZegoEffects

Set AI portrait segmentation background blur parameters

Parameters

Name	Type	Description
param	ZegoEffectsBlurParam	Portrait Segmentation Background Blur Function Parameters.

Details

When using background blur, you need to call [enablePortraitSegmentationBackgroundBlur] enable background blur the background of interface Settings to take effect.

setPortraitSegmentationBackgroundMosaicParam

setPortraitSegmentationBackgroundMosaicParam(param: ZegoEffectsMosaicParam): ZegoEffects

Sets portrait split background Mosaic parameters

Parameters

Name	Type	Description
param	ZegoEffectsMosaicParam	Mosaic parameters.

Details

You need to call [enablePortraitSegmentationBackgroundMosaic] enable background Mosaic after the background of interface Settings to take effect.

setPortraitSegmentationBackgroundPath

setPortraitSegmentationBackgroundPath(imagePath?: string, mode: ZegoEffectsScaleMode): ZegoEffects

Set custom background path for AI portrait segmentation.

Parameters

Name	Type	Description
imagePath	string	Image path.
mode	ZegoEffectsScaleMode	View mode.

Details

When using a custom background, you need to call [enablePortraitSegmentationBackground] enable custom background after the background of interface Settings to take effect.

enableFaceDetection

enableFaceDetection(enable: boolean): ZegoEffects

Turn on face detection

Parameters

Name	Type	Description
enable	boolean

Details

After the face detection is started, the developer can obtain the face detection result by [OnFaceDetectionResult] in [ZegoEffectSetHandler], including the number of faces, face coordinates and so on.

enableFaceLifting

enableFaceLifting(enable: boolean): ZegoEffects

Turn it on and your face will be slimmer and your chin will be thinner

Parameters

Name	Type	Description
enable	boolean	Whether to enable the face-slimming feature; [true] means the face-slimming feature is activated; [false] means the face-slimming feature is turned off. The default value is [false].

Details

Turn it on and your face will be slimmer and your chin will be thinner

enableNoseNarrowing

enableNoseNarrowing(enable: boolean): ZegoEffects

enable the thin nose function, you can call the [setNoseNarrowingParam] interface to set parameters.

Parameters

Name	Type	Description
enable	boolean	True is used to turn on Thin Nose. Default is false

Details

enable the thin nose function, you can call the [setNoseNarrowingParam] interface to set parameters.

enableSmallMouth

enableSmallMouth(enable: boolean): ZegoEffects

To enable the long mouth function, you can call the [SetSmallMouthParam] interface to set the parameters.

Parameters

Name	Type	Description
enable	boolean	Whether to activate the small mouth feature; [true] means the small mouth feature is enabled; [false] means the small mouth feature is disabled. The default value is [false].

Details

To enable the long mouth function, you can call the [SetSmallMouthParam] interface to set the parameters.

on

on(errorCode: number, desc: string): void

The callback for obtaining error information.

Parameters

Name	Type	Description
errorCode	number	Engine error code.
desc	string	Engine error code description.

similarity: number

Update the color tolerance, the larger the tolerance, the larger the range to be replaced, range [0~100], default 67.

smoothness

smoothness: number

Updates the Edge Smoothing Index, the bigger the smoother, but the render will also be slower, range [0~100], default 80.

opacity

opacity: number

Update transparency, range [0~100], default 100 (opacity).

keyColor

width

width: number

Video frame width, in pixels.

height

height: number

The height of the video frame, in pixels.

format

format: ZegoEffectsVideoFrameFormat

Video data frame format.

textureFormat

textureFormat: ZegoEffectsTextureFormat

Texture format, if you are transferring texture, you can specify the format of the corresponding texture, 2D texture or OES texture(Android-specific format).

tranMatrix

tranMatrix: number

When the 2D texture is an OES texture (a format specific to Android), a texture transformation matrix can be passed in. This can be obtained from the getTransformMatrix(float[] mtx) interface of SurfaceTexture.

Platform differences: This is only effective when the OES texture is on the Android platform.

ZegoEffectsWhitenParam

Developers can modify the whitening information through this category.

Details

Developers can modify the whitening parameters through this class.

Properties

intensity

intensity: number

Whitening intensity, range [0~100].

ZegoEffectsWrinklesRemovingParam

Developers can adjust the law pattern removal parameters through this type of adjustment.

Details

Developers can adjust the law pattern removal parameters through this type of adjustment.

Properties

intensity

intensity: number

Wrinkles removing strength, range [-100~100].