Class


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

ZegoEffects

AI Effect function

Details

AI Effect function

Declared in ZegoEffects.h

Methods

create:appid:appSign:

static

create:appid:appSign:

+ (ZegoEffects)public create:(NSInteger) appid appSign:(NSString *) appSign;

Creating an Effects instance

Declared in ZegoEffects.h

Parameters

Name	Type	Description
appid	NSInteger	appid
appSign	NSString *	appSign

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.

getAuthInfo:appSign:

static

getAuthInfo:appSign:

+ (NNString*)getAuthInfo:(NNString*) appSign;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
appSign	NNString*	appSign.

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

+ (NSString *)getVersion;

Gets the SDK's version number.

Declared in ZegoEffects.h

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:config:

static

setAdvancedConfig:config:

+ (void)setAdvancedConfig:(ZegoEffectsAdvancedConfig) config;

Effects advanced function switch.

Declared in ZegoEffects.h

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:resourceInfoList:

static

setResources:resourceInfoList:

+ (void)setResources:(nullable NSArray<NSString*> *) resourceInfoList;

Set effects static resources.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
resourceInfoList	nullable NSArray<NSString>	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:license:

static

create:license:

deprecated

+ (ZegoEffects)public create:(NSString *) license;

Creating an Effects instance

Declared in ZegoEffects.h

Parameters

Name	Type	Description
license	NSString *	Authentication certificate file.

Details

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

Deprecated

This API has been deprecated since 2.1.0.

Return

The ZegoEffects instance object.

create:appid:appSign:callback:

static

create:appid:appSign:callback:

+ (void)create:(NSInteger) appid appSign:(NSString) appSign callback:(void (^)(ZegoEffects, NSInteger)) callback;

Creating an Effects instance

Declared in ZegoEffects.h

Parameters

Name	Type	Description
appid	NSInteger	SDK authentication Appid.
appSign	NSString	SDK authentication AppSign.
callback	void (^)(ZegoEffects, NSInteger)	Create the result callback of the instance request. The callback contains the ZegoEffects object and the authentication error code.

Details

Return ZegoEffects object after authentication. Effects instances need to be created and initialized before calling other functions.

The returned ZegoEffects object is spit out by the callback.

Return

void

setModels:modelInfoList:

static

setModels:modelInfoList:

+ (void)setModels:(NSArray<NSString*> *) modelInfoList;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
modelInfoList	NSArray<NSString>	AI model path

Details

If developers need to use some advanced functions, face detection, portrait segmentation, etc., they need to set up the AI model through this interface, otherwise the AI model-related functions will not be able to be used normally.

When to call /Trigger: it takes effect globally and must be set before creating the Effects instance.

enableAcneRemoving:enable:

- (ZegoEffects)public enableAcneRemoving:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableCheekboneSlimming:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableClarity:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableDarkCirclesRemoving:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableFaceShortening:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableForeheadShortening:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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

enableMandibleSlimming:enable:

- (ZegoEffects)public enableMandibleSlimming:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableNoseLengthening:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableSkinColor:(BOOL) enable;

enable the skin color function

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableWrinklesRemoving:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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

- (ZegoEffectsDeviceLevel)public getDeviceLevel;

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

Declared in ZegoEffects.h

Device leve enumeratioln, corresponding integer number.

setAcneRemovingParam:param:

- (ZegoEffects)public setAcneRemovingParam:(ZegoEffectsAcneRemovingParam) param;

Set acne removing parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsAcneRemovingParam	the acne removing parameters.

Details

Set acne removing parameters.

setBlusher:path:

- (ZegoEffects)public setBlusher:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects)public setBlusherParam:(ZegoEffectsBlusherParam) param;

Set blusher parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsBlusherParam	blusher parameters.

Details

Set blusher parameters.

setCheekboneSlimmingParam:param:

- (ZegoEffects)public setCheekboneSlimmingParam:(ZegoEffectsCheekboneSlimmingParam) param;

Set the cheekbone slimming parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsCheekboneSlimmingParam	Functional parameters of thin cheekbones.

Details

Set the cheekbone slimming parameters.

setClarityParam:param:

- (ZegoEffects)public setClarityParam:(ZegoEffectsClarityParam) param;

Set clarity parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsClarityParam	the clarity parameters.

Details

Set clarity parameters

setColoredcontacts:path:

- (void)setColoredcontacts:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects) setColoredcontactsParam:(ZegoEffectsColoredcontactsParam) param;

Set coloredcontacts parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsColoredcontactsParam	coloredcontacts parameters.

Details

Set coloredcontacts parameters.

setDarkCirclesRemovingParam:param:

- (ZegoEffects)public setDarkCirclesRemovingParam:(ZegoEffectsDarkCirclesRemovingParam) param;

Set the darkcircles removing parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsDarkCirclesRemovingParam	Remove dark circles function parameters.

Details

Set the darkcircles removing parameters.

setEyeliner:path:

- (ZegoEffects)public setEyeliner:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects)public setFaceShorteningParam:(ZegoEffectsFaceShorteningParam) param;

Set the face shortening parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsFaceShorteningParam	Small face function parameters.

Details

Set the face shortening parameters.

setForeheadShorteningParam:param:

- (ZegoEffects) setForeheadShorteningParam:(ZegoEffectsForeheadShorteningParam) param;

Set the forehead shortening parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsForeheadShorteningParam	Reduce forehead height function parameters.

Details

Set the forehead shortening parameters.

setMakeup:path:

- (ZegoEffects)public setMakeup:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects)public setMakeupParam:(ZegoEffectsMakeupParam) param;

Set makeup parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsMakeupParam	makeup parameters.

Details

Set makeup parameters.

setMandibleSlimmingParam:param:

- (ZegoEffects)public setMandibleSlimmingParam:(ZegoEffectsMandibleSlimmingParam) param;

Set the mandible slimming parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsMandibleSlimmingParam	Thin mandible parameters.

Details

Set the mandible slimming parameters.

setNoseLengtheningParam:param:

- (ZegoEffects)public setNoseLengtheningParam:(ZegoEffectsNoseLengtheningParam) param;

Set the nose lengthening parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsNoseLengtheningParam	noselengthening parameters.

Details

Set the nose lengthening parameters.

setSkinColorParam:param:

- (ZegoEffects)public setSkinColorParam:(ZegoEffectsSkinColorParam) param;

Set the skin color parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsSkinColorParam	the skin color strengthen parameters.

Details

Set the skin color parameters.

setSkinColorResPath:bundlePath:

- (ZegoEffects)public setSkinColorResPath:(NSString *) bundlePath;

Set the skin resource path' parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
bundlePath	NSString *	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:param:

- (ZegoEffects)public setWrinklesRemovingParam:(ZegoEffectsWrinklesRemovingParam) param;

Set the wrinkles removing parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsWrinklesRemovingParam	Remove dark circles function parameters.

Details

Set the wrinkles removing parameters.

destroy

- (void)destroy;

Destroy the Effects Object.

Declared in ZegoEffects.h

Used to release resources used by the SDK.

setEventHandler:eventHandler:

- (ZegoEffects)public setEventHandler:(nullable id<ZegoEffectsEventHandler>) 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.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
eventHandler	nullable id<ZegoEffectsEventHandler>	Event notification callback. Developers should override callback related methods to focus on specific notifications based on their own business scenarios. The main callback methods of SDK are in [ZegoEffectsEventHandler].

Details

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.

enableEyesBrightening:enable:

- (ZegoEffects)public enableEyesBrightening:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableLongChin:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableRosy:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableSharpen:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableSmooth:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:path:

- (ZegoEffects)public setEyelashes:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects)public setEyelashesParam:(ZegoEffectsEyelashesParam) param;

Set eyelashes parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsEyelashesParam	Eyelashes parameters.

Details

Set eyelashes parameters.

setEyelinerParam:param:

- (ZegoEffects)public setEyelinerParam:(ZegoEffectsEyelinerParam) param;

Set eyeliner parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsEyelinerParam	Eyeliner parameters.

Details

Set eyeliner parameters.

setEyesBrighteningParam:param:

- (ZegoEffects)public setEyesBrighteningParam:(ZegoEffectsEyesBrighteningParam) param;

Set the brightness parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsEyesBrighteningParam	Set the brightness parameters.

Details

Set the brightness parameters.

setEyeshadow:path:

- (ZegoEffects)public setEyeshadow:(NNString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NNString	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:param:

- (ZegoEffects)public setEyeshadowParam:(ZegoEffectsEyeshadowParam) param;

Set eyeshadow parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsEyeshadowParam	Eye shadow parameters.

Details

Set eyeshadow parameters.

setFilter:path:

- (ZegoEffects)public setFilter:(NSString *) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NSString *	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:param:

- (ZegoEffects)public setFilterParam:(ZegoEffectsFilterParam) param;

Set filter parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsFilterParam	Filter function parameters.

Details

Set filter parameters

setLipstick:path:

- (ZegoEffects)public setLipstick:(NSString) path;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NSString	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:param:

- (ZegoEffects)public setLipstickParam:(ZegoEffectsLipstickParam) param;

Set lipstick parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsLipstickParam	Lipstick parameters.

Details

Set lipstick parameters.

setLongChinParam:param:

- (ZegoEffects)public setLongChinParam:(ZegoEffectsLongChinParam) param;

Set long chin parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsLongChinParam	Set long chin parameters.

Details

Set long chin parameters.

setNoseNarrowingParam:param:

- (ZegoEffects)public setNoseNarrowingParam:(ZegoEffectsNoseNarrowingParam) param;

Set thin nose parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsNoseNarrowingParam	Nose slimming parameters.

Details

Set thin nose parameters.

setPendant:path:

- (ZegoEffects)public setPendant:(NSString *) path;

Set the pendant.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
path	NSString *	absolute path of the pendant.

Details

Developers can set different pendants through this interface. After setting a new pendant, the last set pendant will be overwritten. If you need to close the pendant, please set [nil] The pendant may cover some beauty effects

setRosyParam:param:

- (ZegoEffects)public setRosyParam:(ZegoEffectsRosyParam) param;

set rosy parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsRosyParam	Rosy cheeks function parameters.

Details

set rosy parameters.

setSharpenParam:param:

- (ZegoEffects)public setSharpenParam:(ZegoEffectsSharpenParam) param;

Set the smooth parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsSharpenParam	The parameter of sharpen.

Details

Set the smooth parameters.

setSmallMouthParam:param:

- (ZegoEffects)public setSmallMouthParam:(ZegoEffectsSmallMouthParam) param;

Set the small mouth parameters.

Declared in ZegoEffects.h

Parameters

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

Details

Set the small mouth parameters.

setSmoothParam:param:

- (ZegoEffects)public setSmoothParam:(ZegoEffectsSmoothParam) param;

Set the smooth parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsSmoothParam	Skin smoothing function parameters.

Details

Set the smooth parameters

setTeethWhiteningParam:param:

- (ZegoEffects)public setTeethWhiteningParam:(ZegoEffectsTeethWhiteningParam) param;

Set the white tooth parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsTeethWhiteningParam	Teeth whitening function parameters.

Details

Set the white tooth parameters.

enableBigEyes:enable:

- (ZegoEffects)public enableBigEyes:(BOOL) enable;

Eyes will get bigger when enabled

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:param:

- (ZegoEffects)public setBigEyesParam:(ZegoEffectsBigEyesParam) param;

Set the eye enlargement parameters.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsBigEyesParam	The eye enlargement parameter

Details

Set the eye enlargement parameter

enableTeethWhitening:enable:

- (ZegoEffects)public enableTeethWhitening:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableWhiten:(BOOL) enable;

When opened, the skin will become whiter.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:param:

- (ZegoEffects)public setWhitenParam:(ZegoEffectsWhitenParam) param;

Set whitening parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsWhitenParam	whitening parameters

Details

Set whitening parameters

initEnv:resolution:

- (void)initEnv:(CGSize) resolution;

Initialize the Effects engine environment

Declared in ZegoEffects.h

Parameters

Name	Type	Description
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:param:

- (ZegoEffects)public setFaceLiftingParam:(ZegoEffectsFaceLiftingParam) param;

Set the thin face parameters

Declared in ZegoEffects.h

Parameters

Name	Type	Description
param	ZegoEffectsFaceLiftingParam	The thin face parameters

Details

Set the thin face parameters

uninitEnv

- (void)uninitEnv;

Uninitializes the Effects engine environment

Declared in ZegoEffects.h

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:enable:

- (ZegoEffects)public enableChromaKey:(BOOL) enable;

Enable green screen segmentation.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:imagePath:mode:

- (ZegoEffects)public setChromaKeyBackgroundPath:(NSString *) imagePath mode:(ZegoEffectsScaleMode) mode;

Set the green screen custom background path.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
imagePath	NSString *	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:param:

- (ZegoEffects)public setChromaKeyParam:(ZegoEffectsChromaKeyParam) param;

Sets the green screen partition parameters

Declared in ZegoEffects.h

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:enable:

- (ZegoEffects)public enableChromaKeyBackground:(BOOL) 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.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL

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:enable:

- (ZegoEffects)public enableChromaKeyBackgroundBlur:(BOOL) enable;

Open the green screen background fuzzy segmentation.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableChromaKeyBackgroundMosaic:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enablePortraitSegmentation:(BOOL) enable;

When AI portrait segmentation is enabled.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enablePortraitSegmentationBackground:(BOOL) enable;

Turn on AI Portrait Segmentation Custom Background.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enablePortraitSegmentationBackgroundBlur:(BOOL) enable;

Open ai portrait background segmentation fuzzy.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enablePortraitSegmentationBackgroundMosaic:(BOOL) enable;

Open the ai portrait background segmentation Mosaic.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:param:

- (ZegoEffects)public setChromaKeyBackgroundBlurParam:(ZegoEffectsBlurParam) param;

Sets the green screen background blur parameter

Declared in ZegoEffects.h

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.

setChromaKeyBackgroundBuffer:buffer:mode:

- (ZegoEffects)public setChromaKeyBackgroundBuffer:(CVPixelBufferRef) buffer mode:(ZegoEffectsScaleMode) mode;

Set the green screen split custom background.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	Picture frame data.
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.

Return

ZegoEffects

setChromaKeyBackgroundMosaicParam:param:

- (ZegoEffects)public setChromaKeyBackgroundMosaicParam:(ZegoEffectsMosaicParam) param;

Set the background mosaic parameters of the green screen segmentation.

Declared in ZegoEffects.h

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.

setChromaKeyForegroundPosition:rect:

- (ZegoEffects)public setChromaKeyForegroundPosition:(CGRect) rect;

Sets the green screen segmentation foreground position.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
rect	CGRect

Details

When using a custom background for the green screen segmentation, you can adjust the position coordinates of the foreground through this interface.

setPortraitSegmentationBackgroundBlurParam:param:

- (ZegoEffects)public setPortraitSegmentationBackgroundBlurParam:(ZegoEffectsBlurParam) param;

Set AI portrait segmentation background blur parameters

Declared in ZegoEffects.h

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.

setPortraitSegmentationBackgroundBuffer:buffer:mode:

- (ZegoEffects)public setPortraitSegmentationBackgroundBuffer:(CVPixelBufferRef) buffer mode:(ZegoEffectsScaleMode) mode;

Set up custom backgrounds for AI portrait segmentation

Declared in ZegoEffects.h

Parameters

Name	Type	Description
buffer	CVPixelBufferRef	Picture frame data.
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.

setPortraitSegmentationBackgroundMosaicParam:param:

- (ZegoEffects)public setPortraitSegmentationBackgroundMosaicParam:(ZegoEffectsMosaicParam) param;

Sets portrait split background Mosaic parameters

Declared in ZegoEffects.h

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:imagePath:mode:

- (ZegoEffects)public setPortraitSegmentationBackgroundPath:(NSString *) imagePath mode:(ZegoEffectsScaleMode) mode;

Set custom background path for AI portrait segmentation.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
imagePath	NSString *	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.

setPortraitSegmentationForegroundPosition:rect:

- (ZegoEffects)public setPortraitSegmentationForegroundPosition:(CGRect) rect;

Sets the portrait segmentation foreground position.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
rect	CGRect	The position coordinates of the foreground.

Details

When using a custom background for portrait segmentation, you can adjust the position coordinates of the foreground through this interface.

enableFaceDetection:enable:

- (ZegoEffects)public enableFaceDetection:(BOOL) enable;

Turn on face detection

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL

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:enable:

- (ZegoEffects)public enableFaceLifting:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableNoseNarrowing:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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:enable:

- (ZegoEffects)public enableSmallMouth:(BOOL) enable;

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

Declared in ZegoEffects.h

Parameters

Name	Type	Description
enable	BOOL	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.

processImageBuffer:buff:

- (void)processImageBuffer:(CVPixelBufferRef) buff;

process images, interface needs to pass in an image of type CVPixelBufferRef.

Declared in ZegoEffects.h

Parameters

Name	Type	Description
buff	CVPixelBufferRef	The data of the video frame.

When to call: please call [initEnv] to initialize the engine environment before processing the image. If the engine environment is not initialized, the beauty will be invalid.
Caution: The input buff must be in the format of BGRA32 or RGBA32.

similarity

public float similarity

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

smoothness

public float smoothness

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

opacity

public int opacity

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

keyColor

public int keyColor

Update the color to replace in format: BGR, range [0,0xFFFFFF], default 0x00FF00.

borderSize

public int borderSize

update the edge pixel sampling radius. The larger the borderSize, the smoother the edge color transition and the slower the speed. The pixels at the junction of the background and the foreground often have residual green. Take the average value of nearby pixels as the new pixel value to remove the residual, range [ 0~100], default 1.

score

Declared in ZegoEffectsDefines.h

Properties

intensity

public int height

The height of the video frame, in pixels.

format

public ZegoEffectsVideoFrameFormat format

Video data frame format.

textureFormat

public ZegoEffectsTextureFormat textureFormat

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

ZegoEffectsWhitenParam

Developers can modify the whitening information through this category.

Details

Developers can modify the whitening parameters through this class.

Declared in ZegoEffectsDefines.h

Properties

intensity

public int intensity

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.

Declared in ZegoEffectsDefines.h

Properties

intensity

public int intensity

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