AI Effects
On this page

Class

ZegoEffectsZegoEffectsAdvancedConfig
ZegoEffectsBigEyesParamZegoEffectsBlurParam
ZegoEffectsBlusherParamZegoEffectsCheekboneSlimmingParam
ZegoEffectsCheekParamZegoEffectsChromaKeyParam
ZegoEffectsColoredcontactsParamZegoEffectsDarkCirclesRemovingParam
ZegoEffectsEventHandlerZegoEffectsEyelashesParam
ZegoEffectsEyelinerParamZegoEffectsEyesBrighteningParam
ZegoEffectsEyeshadowParamZegoEffectsFaceDetectionResult
ZegoEffectsFaceLiftingParamZegoEffectsFaceShorteningParam
ZegoEffectsFilterParamZegoEffectsForeheadShorteningParam
ZegoEffectsLipstickParamZegoEffectsLongChinParam
ZegoEffectsMakeupParamZegoEffectsMandibleSlimmingParam
ZegoEffectsMosaicParamZegoEffectsNoseLengtheningParam
ZegoEffectsNoseNarrowingParamZegoEffectsRect
ZegoEffectsRosyParamZegoEffectsSharpenParam
ZegoEffectsSmallMouthParamZegoEffectsSmoothParam
ZegoEffectsTeethWhiteningParamZegoEffectsVideoFrameParam
ZegoEffectsWhitenParamZegoEffectsWrinklesRemovingParam

ZegoEffects

AI Effect function

Details

AI Effect function

Declared in ZegoEffects.java

Methods

create

static
create
public ZegoEffects create(long appid, String appSign)
Creating an Effects instance
Declared in ZegoEffects.java

Parameters

NameTypeDescription
appidlongappid
appSignStringappSign

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

static
getAuthInfo
public String getAuthInfo(String appSign, Context context)
Gets the SDK's authorized message. send authorized message and appID to apply for authentication file to ZEGO server.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
appSignStringappSign.
contextContextcontext.

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
public String getVersion()
Gets the SDK's version number.
Declared in ZegoEffects.java

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
public void setAdvancedConfig(ZegoEffectsAdvancedConfig config)
Effects advanced function switch.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
configZegoEffectsAdvancedConfigeffects Advanced configuration. Such as Render-Mode, Device-Performance-Level, etc.
  • When to call: Before you create the engine.

setResources

static
setResources
public void setResources(ArrayList<String> resourceInfoList)
Set effects static resources.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
resourceInfoListArrayList<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
deprecated
public ZegoEffects create(String license, Context context)
Creating an Effects instance
Declared in ZegoEffects.java

Parameters

NameTypeDescription
licenseStringAuthentication certificate file.
contextContextContext.

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

static
create
public void create(long appid, String appSign, IAsyncEffectCallback effectCallback, Context context)
Creating an Effects instance
Declared in ZegoEffects.java

Parameters

NameTypeDescription
appidlongSDK authentication Appid.
appSignStringSDK authentication AppSign.
effectCallbackIAsyncEffectCallbackCreate the result callback of the instance request. The callback contains the ZegoEffects object and the authentication error code.
contextContextContext.

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

static
setModels
public void setModels(ArrayList<String> modelInfoList)
Set AI model, support multiple models at the same time.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
modelInfoListArrayList<String>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

enableAcneRemoving
public ZegoEffects enableAcneRemoving(boolean enable)
enable the acne removing function, you can set the acne parameters by calling the [setAcneRemovingParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableCheekboneSlimming(boolean enable)
enable the cheekbone slimming function, you can set the cheekbone slimming parameters by calling the [setCheekboneSlimmingParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableClarity(boolean enable)
enable the clarity function, you can set the clarity parameters by calling the [setClarityParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableDarkCirclesRemoving(boolean enable)
enable the darkcircles removing function, you can set the ruddy parameters by calling the [setDarkCirclesRemovingParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanenable 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
public ZegoEffects enableFaceShortening(boolean enable)
enable the face shortening function, you can set the face shortening parameters by calling the [setFaceShorteningParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableForeheadShortening(boolean enable)
enable the forehead shortening function, you can set the forehead shortening parameters by calling the [setForeheadShorteningParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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

enableMandibleSlimming
public ZegoEffects enableMandibleSlimming(boolean enable)
enable the mandible slimming function, you can set the mandible slimming parameters by calling the [setMandibleSlimmingParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableNoseLengthening(boolean enable)
enable the nose lengthening function, you can set the nose lengthening parameters by calling the [setNoseLengtheningParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableSkinColor(boolean enable)
enable the skin color function
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableWrinklesRemoving(boolean enable)
Enable the wrinkles removing function, you can set the wrinkles removing parameters by calling the [setWrinklesRemovingParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffectsDeviceLevel 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.java

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 device level to assist in locating the problem.

Device leve enumeratioln, corresponding integer number.

setAcneRemovingParam

setAcneRemovingParam
public ZegoEffects setAcneRemovingParam(ZegoEffectsAcneRemovingParam param)
Set acne removing parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsAcneRemovingParamthe acne removing parameters.

Details

Set acne removing parameters.

setBlusher

setBlusher
public ZegoEffects setBlusher(String path)
Set the blusher resource, set [null] to remove the blusher by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringThe 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
public ZegoEffects setBlusherParam(ZegoEffectsBlusherParam param)
Set blusher parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsBlusherParamblusher parameters.

Details

Set blusher parameters.

setCheekboneSlimmingParam

setCheekboneSlimmingParam
public ZegoEffects setCheekboneSlimmingParam(ZegoEffectsCheekboneSlimmingParam param)
Set the cheekbone slimming parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsCheekboneSlimmingParamFunctional parameters of thin cheekbones.

Details

Set the cheekbone slimming parameters.

setClarityParam

setClarityParam
public ZegoEffects setClarityParam(ZegoEffectsClarityParam param)
Set clarity parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsClarityParamthe clarity parameters.

Details

Set clarity parameters

setColoredcontacts

setColoredcontacts
void setColoredcontacts(String path)
Set the coloredcontacts resource, set [null] to remove the coloredcontacts by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringAbsolute 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
ZegoEffects setColoredcontactsParam(ZegoEffectsColoredcontactsParam param)
Set coloredcontacts parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsColoredcontactsParamcoloredcontacts parameters.

Details

Set coloredcontacts parameters.

setDarkCirclesRemovingParam

setDarkCirclesRemovingParam
public ZegoEffects setDarkCirclesRemovingParam(ZegoEffectsDarkCirclesRemovingParam param)
Set the darkcircles removing parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsDarkCirclesRemovingParamRemove dark circles function parameters.

Details

Set the darkcircles removing parameters.

setEyeliner

setEyeliner
public ZegoEffects setEyeliner(String path)
Set the eyeliner resource, set [null] to remove the eyeliner by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringThe 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
public ZegoEffects setFaceShorteningParam(ZegoEffectsFaceShorteningParam param)
Set the face shortening parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsFaceShorteningParamSmall face function parameters.

Details

Set the face shortening parameters.

setForeheadShorteningParam

setForeheadShorteningParam
ZegoEffects setForeheadShorteningParam(ZegoEffectsForeheadShorteningParam param)
Set the forehead shortening parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsForeheadShorteningParamReduce forehead height function parameters.

Details

Set the forehead shortening parameters.

setMakeup

setMakeup
public ZegoEffects setMakeup(String path)
Set the makeup resource, set [null] to remove the makeup by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringThe 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
public ZegoEffects setMakeupParam(ZegoEffectsMakeupParam param)
Set makeup parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsMakeupParammakeup parameters.

Details

Set makeup parameters.

setMandibleSlimmingParam

setMandibleSlimmingParam
public ZegoEffects setMandibleSlimmingParam(ZegoEffectsMandibleSlimmingParam param)
Set the mandible slimming parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsMandibleSlimmingParamThin mandible parameters.

Details

Set the mandible slimming parameters.

setNoseLengtheningParam

setNoseLengtheningParam
public ZegoEffects setNoseLengtheningParam(ZegoEffectsNoseLengtheningParam param)
Set the nose lengthening parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsNoseLengtheningParamnoselengthening parameters.

Details

Set the nose lengthening parameters.

setSkinColorParam

setSkinColorParam
public ZegoEffects setSkinColorParam(ZegoEffectsSkinColorParam param)
Set the skin color parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsSkinColorParamthe skin color strengthen parameters.

Details

Set the skin color parameters.

setSkinColorResPath

setSkinColorResPath
public ZegoEffects setSkinColorResPath(String bundlePath)
Set the skin resource path' parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
bundlePathStringthe 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
public ZegoEffects setWrinklesRemovingParam(ZegoEffectsWrinklesRemovingParam param)
Set the wrinkles removing parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsWrinklesRemovingParamRemove dark circles function parameters.

Details

Set the wrinkles removing parameters.

destroy

destroy
public void destroy()
Destroy the Effects Object.
Declared in ZegoEffects.java

Used to release resources used by the SDK.

setEventHandler

setEventHandler
public ZegoEffects setEventHandler(ZegoEffectsEventHandler eventHandler)
Sets up the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
eventHandlerZegoEffectsEventHandlerEvent 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 [null], all the callbacks set previously will be cleared.

enableEyesBrightening

enableEyesBrightening
public ZegoEffects enableEyesBrightening(boolean enable)
enable bright eyes, developers can set the bright eyes parameter by calling [seteyesbrighteningParam].
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableLongChin(boolean enable)
Long chin function is enabled, and parameters of long chin can be set by calling [SetLongChinParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableRosy(boolean enable)
enable the ruddy function, you can set the ruddy parameters by calling the [setRosyParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableSharpen(boolean enable)
enable the sharpening function, you can call the [setSharpenParam] interface to set the sharpening parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableSmooth(boolean enable)
The function of peeling is enabled, and the [setSmoothParam] interface can be called to set the peeling parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects setEyelashes(String path)
Set the eyelashes resource, set [null] to remove the eyelashes by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringAbsolute 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
public ZegoEffects setEyelashesParam(ZegoEffectsEyelashesParam param)
Set eyelashes parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsEyelashesParamEyelashes parameters.

Details

Set eyelashes parameters.

setEyelinerParam

setEyelinerParam
public ZegoEffects setEyelinerParam(ZegoEffectsEyelinerParam param)
Set eyeliner parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsEyelinerParamEyeliner parameters.

Details

Set eyeliner parameters.

setEyesBrighteningParam

setEyesBrighteningParam
public ZegoEffects setEyesBrighteningParam(ZegoEffectsEyesBrighteningParam param)
Set the brightness parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsEyesBrighteningParamSet the brightness parameters.

Details

Set the brightness parameters.

setEyeshadow

setEyeshadow
public ZegoEffects setEyeshadow(String path)
Set the eyeshadow resource, set [null] to remove the eyeshadow by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringThe 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
public ZegoEffects setEyeshadowParam(ZegoEffectsEyeshadowParam param)
Set eyeshadow parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsEyeshadowParamEye shadow parameters.

Details

Set eyeshadow parameters.

setFilter

setFilter
public ZegoEffects setFilter(String path)
Set the filter resource, set [null] to remove the filter by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringThe 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
public ZegoEffects setFilterParam(ZegoEffectsFilterParam param)
Set filter parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsFilterParamFilter function parameters.

Details

Set filter parameters

setLipstick

setLipstick
public ZegoEffects setLipstick(String path)
Set up lipstick resources, set [null] to remove the lipstick by default.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringAbsolute 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
public ZegoEffects setLipstickParam(ZegoEffectsLipstickParam param)
Set lipstick parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsLipstickParamLipstick parameters.

Details

Set lipstick parameters.

setLongChinParam

setLongChinParam
public ZegoEffects setLongChinParam(ZegoEffectsLongChinParam param)
Set long chin parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsLongChinParamSet long chin parameters.

Details

Set long chin parameters.

setNoseNarrowingParam

setNoseNarrowingParam
public ZegoEffects setNoseNarrowingParam(ZegoEffectsNoseNarrowingParam param)
Set thin nose parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsNoseNarrowingParamNose slimming parameters.

Details

Set thin nose parameters.

setPendant

setPendant
public ZegoEffects setPendant(String path)
Set the pendant.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
pathStringabsolute 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 [null] The pendant may cover some beauty effects

setRosyParam

setRosyParam
public ZegoEffects setRosyParam(ZegoEffectsRosyParam param)
set rosy parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsRosyParamRosy cheeks function parameters.

Details

set rosy parameters.

setSharpenParam

setSharpenParam
public ZegoEffects setSharpenParam(ZegoEffectsSharpenParam param)
Set the smooth parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsSharpenParamThe parameter of sharpen.

Details

Set the smooth parameters.

setSmallMouthParam

setSmallMouthParam
public ZegoEffects setSmallMouthParam(ZegoEffectsSmallMouthParam param)
Set the small mouth parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsSmallMouthParam"Small mouth function parameters."

Details

Set the small mouth parameters.

setSmoothParam

setSmoothParam
public ZegoEffects setSmoothParam(ZegoEffectsSmoothParam param)
Set the smooth parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsSmoothParamSkin smoothing function parameters.

Details

Set the smooth parameters

setTeethWhiteningParam

setTeethWhiteningParam
public ZegoEffects setTeethWhiteningParam(ZegoEffectsTeethWhiteningParam param)
Set the white tooth parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsTeethWhiteningParamTeeth whitening function parameters.

Details

Set the white tooth parameters.

enableBigEyes

enableBigEyes
public ZegoEffects enableBigEyes(boolean enable)
Eyes will get bigger when enabled
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects setBigEyesParam(ZegoEffectsBigEyesParam param)
Set the eye enlargement parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsBigEyesParamThe eye enlargement parameter

Details

Set the eye enlargement parameter

enableTeethWhitening

enableTeethWhitening
public ZegoEffects enableTeethWhitening(boolean enable)
Open the teeth will become more white, you can set some parameters through the [setTeethWhiteningParam] interface.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableWhiten(boolean enable)
When opened, the skin will become whiter.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects setWhitenParam(ZegoEffectsWhitenParam param)
Set whitening parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsWhitenParamwhitening parameters

Details

Set whitening parameters

initEnv

initEnv
public void initEnv(int width, int height)
Initialize the Effects engine environment
Declared in ZegoEffects.java

Parameters

NameTypeDescription
widthintwidth of picture.
heightintHeight of the picture.

Details

Before processing image or video data, you need to call this interface to initialize the effects engine environment. If you use texture for image processing, you need to call this interface on the GL thread, otherwise it will cause the beauty to fail. In the first initialization, if ai-related functions are used, this interface will be time-consuming, please do not call this interface on the main thread, otherwise it will cause the UI thread to stall.

setFaceLiftingParam

setFaceLiftingParam
public ZegoEffects setFaceLiftingParam(ZegoEffectsFaceLiftingParam param)
Set the thin face parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsFaceLiftingParamThe thin face parameters

Details

Set the thin face parameters

uninitEnv

uninitEnv
public void uninitEnv()
Uninitializes the Effects engine environment
Declared in ZegoEffects.java

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
public ZegoEffects enableChromaKey(boolean enable)
Enable green screen segmentation.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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.

setChromaKeyBackgroundTexture

setChromaKeyBackgroundTexture
public ZegoEffects setChromaKeyBackgroundTexture(int textureID, ZegoEffectsVideoFrameParam param, ZegoEffectsScaleMode mode)
Set the green screen split custom background.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
textureIDintTexture ID, which the SDK uses to get the Texture data.
paramZegoEffectsVideoFrameParamData frame format.
modeZegoEffectsScaleModeView mode.

Details

Set the green screen split custom background.

setChromaKeyBackgroundPath

setChromaKeyBackgroundPath
public ZegoEffects setChromaKeyBackgroundPath(String imagePath, ZegoEffectsScaleMode mode)
Set the green screen custom background path.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
imagePathStringImage path.
modeZegoEffectsScaleModeView 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
public ZegoEffects setChromaKeyParam(ZegoEffectsChromaKeyParam param)
Sets the green screen partition parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsChromaKeyParamGreen screen segmentation function parameters.

Details

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

enableChromaKeyBackground

enableChromaKeyBackground
public ZegoEffects enableChromaKeyBackground(boolean 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.java

Parameters

NameTypeDescription
enableboolean

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
public ZegoEffects enableChromaKeyBackgroundBlur(boolean enable)
Open the green screen background fuzzy segmentation.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableChromaKeyBackgroundMosaic(boolean enable)
Turn on the green background Mosaic. The SDK engine will turn the green background into a Mosaic after startup.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enablePortraitSegmentation(boolean enable)
When AI portrait segmentation is enabled.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enablePortraitSegmentationBackground(boolean enable)
Turn on AI Portrait Segmentation Custom Background.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enablePortraitSegmentationBackgroundBlur(boolean enable)
Open ai portrait background segmentation fuzzy.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enablePortraitSegmentationBackgroundMosaic(boolean enable)
Open the ai portrait background segmentation Mosaic.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects setChromaKeyBackgroundBlurParam(ZegoEffectsBlurParam param)
Sets the green screen background blur parameter
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsBlurParamGreen 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

setChromaKeyBackgroundBuffer
public ZegoEffects setChromaKeyBackgroundBuffer(byte[] buffer, int bufferLength, ZegoEffectsVideoFrameParam param, ZegoEffectsScaleMode mode)
Set the green screen split custom background.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
bufferbyte[]Picture frame data.
bufferLengthintLength of image frame data.
paramZegoEffectsVideoFrameParamVideo frame parameters.
modeZegoEffectsScaleModeView 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

setChromaKeyBackgroundMosaicParam
public ZegoEffects setChromaKeyBackgroundMosaicParam(ZegoEffectsMosaicParam param)
Set the background mosaic parameters of the green screen segmentation.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsMosaicParamMosaic parameters.

Details

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

setChromaKeyForegroundPosition

setChromaKeyForegroundPosition
public ZegoEffects setChromaKeyForegroundPosition(ZegoEffectsRect rect)
Sets the green screen segmentation foreground position.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
rectZegoEffectsRect

Details

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

setPortraitSegmentationBackgroundBlurParam

setPortraitSegmentationBackgroundBlurParam
public ZegoEffects setPortraitSegmentationBackgroundBlurParam(ZegoEffectsBlurParam param)
Set AI portrait segmentation background blur parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsBlurParamPortrait 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

setPortraitSegmentationBackgroundBuffer
public ZegoEffects setPortraitSegmentationBackgroundBuffer(byte[] buffer, int bufferLength, ZegoEffectsVideoFrameParam param, ZegoEffectsScaleMode mode)
Set up custom backgrounds for AI portrait segmentation
Declared in ZegoEffects.java

Parameters

NameTypeDescription
bufferbyte[]Picture frame data.
bufferLengthintLength of picture frame data.
paramZegoEffectsVideoFrameParamPicture frame format.
modeZegoEffectsScaleModeView 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

setPortraitSegmentationBackgroundMosaicParam
public ZegoEffects setPortraitSegmentationBackgroundMosaicParam(ZegoEffectsMosaicParam param)
Sets portrait split background Mosaic parameters
Declared in ZegoEffects.java

Parameters

NameTypeDescription
paramZegoEffectsMosaicParamMosaic parameters.

Details

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

setPortraitSegmentationBackgroundPath

setPortraitSegmentationBackgroundPath
public ZegoEffects setPortraitSegmentationBackgroundPath(String imagePath, ZegoEffectsScaleMode mode)
Set custom background path for AI portrait segmentation.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
imagePathStringImage path.
modeZegoEffectsScaleModeView mode.

Details

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

setPortraitSegmentationBackgroundTexture

setPortraitSegmentationBackgroundTexture
public ZegoEffects setPortraitSegmentationBackgroundTexture(int textureID, ZegoEffectsVideoFrameParam param, ZegoEffectsScaleMode mode)
Set the AI portrait segmentation to customize the background.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
textureIDintThe SDK retrieves the current video data from this texture ID.
paramZegoEffectsVideoFrameParamVideo frame format.
modeZegoEffectsScaleModeView mode.

Details

When using a custom background, you need to call [enablePortraitSegmentationBackground] enable custom background after the background of interface Settings to take effect. If the texture is decoded from video, you need to call this interface again when the video texture is updated to refresh the background. This interface must be called in the GL environment where the texture is generated, so that the SDK can read the texture content.

setPortraitSegmentationForegroundPosition

setPortraitSegmentationForegroundPosition
public ZegoEffects setPortraitSegmentationForegroundPosition(ZegoEffectsRect rect)
Sets the portrait segmentation foreground position.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
rectZegoEffectsRectThe 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

enableFaceDetection
public ZegoEffects enableFaceDetection(boolean enable)
Turn on face detection
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enableboolean

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
public ZegoEffects enableFaceLifting(boolean enable)
Turn it on and your face will be slimmer and your chin will be thinner
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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
public ZegoEffects enableNoseNarrowing(boolean enable)
enable the thin nose function, you can call the [setNoseNarrowingParam] interface to set parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanTrue 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
public ZegoEffects enableSmallMouth(boolean enable)
To enable the long mouth function, you can call the [SetSmallMouthParam] interface to set the parameters.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
enablebooleanWhether 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.

processImageBufferRGB

processImageBufferRGB
public void processImageBufferRGB(byte[] data, int dataLength, ZegoEffectsVideoFrameParam param)
To process images, the interface needs to pass in images of type Buffer, which only supports data in the RGB color space.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
databyte[]The data of the video frame.
dataLengthintThe length of the data.
paramZegoEffectsVideoFrameParamThe parameters of the video frame.

Details

please call [initEnv] to initialize the engine environment before processing the image. If the engine environment is not initialized, the beauty will be invalid.

processImageBufferYUV

processImageBufferYUV
public void processImageBufferYUV(ByteBuffer[] data, int[] dataLength, ZegoEffectsVideoFrameParam param)
To process images, the interface needs to pass in images of type Buffer, which only supports data in the YUV color space.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
dataByteBuffer[]data The raw data of the video frame, I420 needs to consider data[0,1,2].
dataLengthint[]dataLength data length, I420 need to consider dataLength [0,1,2].
paramZegoEffectsVideoFrameParamVideo frame parameters.

Details

please call [initEnv] to initialize the engine environment before processing the image. If the engine environment is not initialized, the beauty will be invalid.

processTexture

processTexture
public int processTexture(int texture_id, ZegoEffectsVideoFrameParam param)
To process images, the interface needs to pass in an image type of Texture.
Declared in ZegoEffects.java

Parameters

NameTypeDescription
texture_idintTexture ID, which the SDK uses to get the Texture data
paramZegoEffectsVideoFrameParamVideo frame parameters.

Details

Please call [initEnv] to initialize the engine environment before processing the image. If the engine environment is not initialized, the beauty will be invalid.

Return

Texture ID after effects are processed.

ZegoEffectsAdvancedConfig

Engine configuration class

Details

Must be called before Effects is created.

Declared in entity/ZegoEffectsAdvancedConfig.java

Properties

advancedConfig

advancedConfig
public HashMap<String, String> advancedConfig

Other special function switches,such as Render-Mode, Device-Performance-Level, etc. If not set, no special function will be used by default. Please contact ZEGO technical support before use.

ZegoEffectsBigEyesParam

Big Eye Parameters.

Details

Developers can modify the big eye intensity through this category.

Declared in entity/ZegoEffectsBigEyesParam.java

Properties

intensity

intensity
public int intensity

Big eye intensity, value range [0~100].

ZegoEffectsBlurParam

Blur Parameters.

Details

Developers can modify the blur intensity through this class.

Declared in entity/ZegoEffectsBlurParam.java

Properties

intensity

intensity
public int intensity

Blur intensity, value range [0~100].

ZegoEffectsBlusherParam

Developers can adjust the blusher parameters through this category.

Details

Developers can adjust the blusher parameters through this category.

Declared in entity/ZegoEffectsBlusherParam

Properties

intensity

intensity
public int intensity

Blusher intensity, range [0~100].

ZegoEffectsCheekParam

Blush parameters.

Details

Developers can modify the blush intensity and other parameters through this category.

Declared in entity/ZegoEffectsCheekParam.java

Properties

intensity

intensity
public int intensity

Blush intensity, value range [0~100].

ZegoEffectsCheekboneSlimmingParam

Developers can adjust thin cheekbones parameters through this class.

Details

Developers can adjust thin cheekbones parameters through this class.

Declared in entity/ZegoEffectsCheekboneSlimmingParam.java

Properties

intensity

intensity
public int intensity

Cheekbone slimming strength, range [0~100].

ZegoEffectsChromaKeyParam

Chroma key parameter.

Details

Developers can set the chroma key parameters as needed.

Declared in entity/ZegoEffectsChromaKeyParam.java

Properties

similarity

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

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

opacity
public int opacity

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

keyColor

keyColor
public int keyColor

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

borderSize

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.

ZegoEffectsColoredcontactsParam

Developers can adjust the coloredcontacts parameters through this category.

Details

Developers can adjust the coloredcontacts parameters through this category.

Declared in entity/ZegoEffectsColoredcontactsParam

Properties

intensity

intensity
public int intensity

Coloredcontacts intensity, range [0~100].

ZegoEffectsDarkCirclesRemovingParam

Developers can adjust the dark circles removal parameters through this category.

Details

Developers can adjust the dark circles removal parameters through this category.

Declared in entity/ZegoEffectsDarkCirclesRemovingParam.java

Properties

intensity

intensity
public int intensity

Darkcircles removing strength, range [0~100].

ZegoEffectsEventHandler

Callback function

Details

Containing AI Effect callback functions.

Declared in callback/ZegoEffectsEventHandler.java

Methods

onError

onError
public void onError(ZegoEffects effects, int errorCode, String desc)
The callback for obtaining error information.
Declared in callback/ZegoEffectsEventHandler.java

Parameters

NameTypeDescription
effectsZegoEffects[in/out] The handle of the instance.
errorCodeintEngine error code.
descStringEngine error code description.

Details

When the SDK functions are not used correctly, the callback prompts for detailed error information.

onFaceDetectionResult

onFaceDetectionResult
public void onFaceDetectionResult(ZegoEffectsFaceDetectionResult[] results, ZegoEffects effects)
Face detection callback.
Declared in callback/ZegoEffectsEventHandler.java

Parameters

NameTypeDescription
resultsZegoEffectsFaceDetectionResult[]Face result.
effectsZegoEffectseffects

Details

The developer can start face detection through [EnableFacedetection], and the SDK will return the detected face data through this callback.

ZegoEffectsEyelashesParam

Developers can adjust the eyelashes parameters through this category.

Details

Developers can adjust the eyelashes parameters through this category.

Declared in entity/ZegoEffectsEyelashesParam

Properties

intensity

intensity
public int intensity

Eyelashes intensity, range [0~100].

ZegoEffectsEyelinerParam

Developers can adjust eyeliner parameters through this category.

Details

Developers can adjust eyeliner parameters through this category.

Declared in entity/ZegoEffectsEyelinerParam.java

Properties

intensity

intensity
public int intensity

Eyeliner intensity, range [0~100].

ZegoEffectsEyesBrighteningParam

Bright eye parameters.

Details

Developers can use this class to set parameters such as brightness intensity.

Declared in entity/ZegoEffectsEyesBrighteningParam.java

Properties

intensity

intensity
public int intensity

Brightness intensity, range [0~100].

ZegoEffectsEyeshadowParam

Developers can adjust eye shadow properties through this class.

Details

Developers can adjust eye shadow properties through this class.

Declared in entity/ZegoEffectsEyeshadowParam.java

Properties

intensity

intensity
public int intensity

Detailed information: Eye shadow intensity, range [0~100].

ZegoEffectsFaceDetectionResult

Face detection data.

Details

Face detection data.

Declared in entity/ZegoEffectsFaceDetectionResult.java

Properties

score

score
public float score

The confidence of the face, the greater the greater the probability is the face.

rect

rect
public ZegoEffectsRect rect

The rectangular frame where the face is located, completely includes the entire face, the unit is pixel, and the coordinate system is in the upper left corner of the input image.

ZegoEffectsFaceLiftingParam

Developers can adjust face-lifting parameters through this class.

Details

Developers can adjust face-lifting parameters through this class.

Declared in entity/ZegoEffectsFaceLiftingParam.java

Properties

intensity

intensity
public int intensity

Face lean strength, range [-100~100].

ZegoEffectsFaceShorteningParam

Developers can adjust the small face parameters through this class.

Details

Developers can adjust the small face parameters through this class.

Declared in entity/ZegoEffectsFaceShorteningParam.java

Properties

intensity

intensity
public int intensity

Face shortening strength, range [0~100].

ZegoEffectsFilterParam

Filter color style parameters.

Details

Filter color style parameters.

Declared in entity/ZegoEffectsFilterParam.java

Properties

intensity

intensity
public int intensity

developers can adjust the filter strength through this property.

ZegoEffectsForeheadShorteningParam

Developers can use this type of adjustment to reduce the forehead height parameter.

Details

Developers can use this type of adjustment to reduce the forehead height parameter.

Declared in entity/ZegoEffectsForeheadShorteningParam.java

Properties

intensity

intensity
public int intensity

Forehead shortening strength, range [-100~100].

ZegoEffectsLipstickParam

Developers can adjust the lipstick parameters through this category.

Details

Developers can adjust the lipstick parameters through this category.

Declared in entity/ZegoEffectsLipstickParam

Properties

intensity

intensity
public int intensity

LIpstick intensity, range [0~100].

ZegoEffectsLongChinParam

Developers can use this class to adjust the chin of the face.

Details

Developers can use this class to adjust the chin of the face.

Declared in entity/ZegoEffectsLongChinParam.java

Properties

intensity

intensity
public int intensity

Long chin strength, range [-100 to 100].

ZegoEffectsMakeupParam

Developers can adjust the makeup parameters through this category.

Details

Developers can adjust the makeup parameters through this category.

Declared in entity/ZegoEffectsMakeupParam

Properties

intensity

intensity
public int intensity

Makeup intensity, range [0~100].

ZegoEffectsMandibleSlimmingParam

Developers can adjust thin mandible parameters through this class.

Details

Developers can adjust thin mandible parameters through this class.

Declared in entity/ZegoEffectsMandibleSlimmingParam.java

Properties

intensity

intensity
public int intensity

mandible slimming strength, range [0~100].

ZegoEffectsMosaicParam

Mosaic parameters.

Details

Mosaic parameters.

Declared in entity/ZegoEffectsMosaicParam.java

Properties

intensity

intensity
public int intensity

Mosaic intensity [0~100].

type

type

Sets the Mosaic type. Default is triangle.

ZegoEffectsNoseLengtheningParam

Nose lengthening strength, range [-100~100].

Details

Nose lengthening strength, range [-100~100].

Declared in entity/ZegoEffectsNoseLengtheningParam.java

Properties

intensity

intensity
public int intensity

Nose lengthening strength, range [-100~100].

ZegoEffectsNoseNarrowingParam

Developers can adjust the skinny nose parameter with this class.

Details

Developers can adjust the skinny nose parameter with this class.

Declared in entity/ZegoEffectsNoseNarrowingParam.java

Properties

intensity

intensity
public int intensity

Thin nose intensity, range [0-100].

ZegoEffectsRect

The rectangle class with the upper left corner coordinate system as the origin.

Details

The rectangle class with the upper left corner coordinate system as the origin.

Declared in entity/ZegoEffectsRect.java

Properties

x

x
public int x

X value of origin.

y

y
public int y

Y value of origin.

width

width
public int width

The width of a rectangle, in pixels.

height

height
public int height

The height of the rectangle, in pixels.

ZegoEffectsRosyParam

Developers can adjust rosy parameters through this category.

Details

Developers can adjust rosy parameters through this category.

Declared in entity/ZegoEffectsRosyParam.java

Properties

intensity

intensity
public int intensity

Rosy intensity, range [0~100].

ZegoEffectsSharpenParam

Developers can adjust the sharpening parameters through this class.

Details

Developers can adjust the sharpening parameters through this class.

Declared in entity/ZegoEffectsSharpenParam.java

Properties

intensity

intensity
public int intensity

Sharpening intensity, range [0~100].

ZegoEffectsSmallMouthParam

Developers can adjust thin mouth parameters through this class.

Details

Developers can adjust thin mouth parameters through this class.

Declared in entity/ZegoEffectsSmallMouthParam.java

Properties

intensity

intensity
public int intensity

Small mouth strength, range [-100~100].

ZegoEffectsSmoothParam

Developers can adjust the microdermabrasion parameters through this category.

Details

Developers can adjust the microdermabrasion parameters through this category.

Declared in entity/ZegoEffectsSmoothParam.java

Properties

intensity

intensity
public int intensity

Microdermabrasion intensity, range [0~100].

ZegoEffectsTeethWhiteningParam

Developers can adjust white teeth parameters through this category.

Details

Developers can adjust white teeth parameters through this category.

Declared in entity/ZegoEffectsTeethWhiteningParam.java

Properties

intensity

intensity
public int intensity

White tooth strength, range [0~100].

ZegoEffectsVideoFrameParam

Detailed video frame parameters.

Details

Detailed video frame parameters.

Declared in entity/ZegoEffectsVideoFrameParam.java

Properties

width

width
public int width

Video frame width, in pixels.

height

height
public int height

The height of the video frame, in pixels.

format

format

Video data frame format.

textureFormat

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).

tranMatrix

tranMatrix
public float tranMatrix

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.

Declared in entity/ZegoEffectsWhitenParam.java

Properties

intensity

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 entity/ZegoEffectsWrinklesRemovingParam.java

Properties

intensity

intensity
public int intensity

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

Previous

Function List

Next

Interface