ZegoEffectsPlugin class Null safety

Methods

create(int appID, String appSign) → Future<int>
Create Zego Effects SDK based on authentication. The authentication is handled internally, and users only need to pass the appID and appSign.
destroy() → Future<void>
Destroy the Zego Effects SDK instance. This method is used to release resources related to the Zego Effects SDK, ensuring proper cleanup when the SDK is no longer needed.
enableAcneRemoving(bool enable) → Future<void>
Enable acne removal.
enableBigEyes(bool enable) → Future<void>
Enable big eyes effect.
enableCheekboneSlimming(bool enable) → Future<void>
Enable cheekbone slimming.
enableChromaKey(bool enable) → Future<void>
Enable chroma key.
enableChromaKeyBackground(bool enable) → Future<void>
Enable chroma key background. Enabling chroma key background will disable blur background and mosaic background functions.
enableChromaKeyBackgroundBlur(bool enable) → Future<void>
Enable chroma key blur background. Enabling chroma key blur background will disable custom background and mosaic background functions.
enableChromaKeyBackgroundMosaic(bool enable) → Future<void>
Enable chroma key mosaic background. Enabling chroma key mosaic background will disable custom background and blur background functions.
enableClarity(bool enable) → Future<void>
Enable clarity.
enableDarkCirclesRemoving(bool enable) → Future<void>
Enable dark circles removal.
enableEyesBrightening(bool enable) → Future<void>
Enable eyes brightening.
enableFaceDetection(bool enable) → Future<void>
Enable face detection.
enableFaceLifting(bool enable) → Future<void>
Enable face lifting.
enableFaceShortening(bool enable) → Future<void>
Enable face shortening.
enableForeheadShortening(bool enable) → Future<void>
Enable forehead shortening.
enableImageProcessing(bool enable) → Future<void>
Enable or disable custom image processing and effects.
enableLongChin(bool enable) → Future<void>
Enable long chin effect.
enableMandibleSlimming(bool enable) → Future<void>
Enable mandible slimming.
enableNoseLengthening(bool enable) → Future<void>
Enable nose lengthening.
enableNoseNarrowing(bool enable) → Future<void>
Enable nose narrowing.
enablePortraitSegmentation(bool enable) → Future<void>
Enable or disable portrait segmentation.
enablePortraitSegmentationBackground(bool enable) → Future<void>
Enable portrait segmentation. Enabling portrait segmentation will disable custom background and mosaic background functions.
enablePortraitSegmentationBackgroundBlur(bool enable) → Future<void>
Enable portrait segmentation with a blur background effect. Enabling a blur background will disable custom background and mosaic background functions.
enablePortraitSegmentationBackgroundMosaic(bool enable) → Future<void>
Enable portrait segmentation with a mosaic background effect. Enabling a mosaic background will disable custom background and blur background functions.
enableRosy(bool enable) → Future<void>
Enable rosy effect.
enableSharpen(bool enable) → Future<void>
Enable sharpening.
enableSkinColor(bool enable) → Future<void>
Enable skin color adjustment.
enableSmallMouth(bool enable) → Future<void>
Enable small mouth effect.
enableSmooth(bool enable) → Future<void>
Enable smoothing.
enableTeethWhitening(bool enable) → Future<void>
Enable teeth whitening.
enableWhiten(bool enable) → Future<void>
Enable whitening.
enableWrinklesRemoving(bool enable) → Future<void>
Enable wrinkle removal.
getAuthInfo(String appSign) → Future<String>
Get SDK authentication information. You can apply for an authentication file from the ZEGO server with the authentication information and appID.
getResourcesFolder() → Future<String>
Get the current device's resource path.
getVersion() → Future<String>
Get the current Effects SDK version
initEnv(Size resolution) → Future<int>
Initialize the Zego Effects environment and set the desired resolution.
setAcneRemovingParam(ZegoEffectsAcneRemovingParam param) → Future<void>
Set the parameters for acne removal.
setBigEyesParam(ZegoEffectsBigEyesParam param) → Future<void>
Set the parameters for the big eyes effect.
setBlusher(String name) → Future<void>
Set the blush effect.
setBlusherParam(ZegoEffectsBlusherParam param) → Future<void>
Set the parameters for the blush effect.
setBlusherPath(String path) → Future<void>
Set the blush effect using an absolute resource path.
setCheekboneSlimmingParam(ZegoEffectsCheekboneSlimmingParam param) → Future<void>
Set the parameters for cheekbone slimming.
setChromaKeyBackgroundBlurParam(ZegoEffectsBlurParam param) → Future<void>
Set the parameters for the chroma key blur background.
setChromaKeyBackgroundMosaicParam(ZegoEffectsMosaicParam param) → Future<void>
Set the parameters for the chroma key mosaic background.
setChromaKeyBackgroundPath(String imagePath, ZegoEffectsScaleMode mode) → Future<void>
Set the custom background image path for chroma key.
setChromaKeyForegroundPosition(double x, double y, double width, double height) → Future<void>
Set the position and size of the chroma key foreground.
setChromaKeyParam(ZegoEffectsChromaKeyParam param) → Future<void>
Set the parameters for chroma key.
setClarityParam(ZegoEffectsClarityParam param) → Future<void>
Set the parameters for clarity.
setColoredcontacts(String name) → Future<void>
Set the colored contacts effect.
setColoredcontactsParam(ZegoEffectsColoredcontactsParam param) → Future<void>
Set the parameters for the colored contacts effect.
setColoredcontactsPath(String path) → Future<void>
Set the colored contacts effect using an absolute resource path.
setDarkCirclesRemovingParam(ZegoEffectsDarkCirclesRemovingParam param) → Future<void>
Set the parameters for dark circles removal.
setEyelashes(String name) → Future<void>
Set the eyelashes effect.
setEyelashesParam(ZegoEffectsEyelashesParam param) → Future<void>
Set the parameters for the eyelashes effect.
setEyelashesPath(String path) → Future<void>
Set the eyelashes effect using an absolute resource path.
setEyeliner(String name) → Future<void>
Set the eyeliner effect.
setEyelinerParam(ZegoEffectsEyelinerParam param) → Future<void>
Set the parameters for the eyeliner effect.
setEyelinerPath(String path) → Future<void>
Set the eyeliner effect using an absolute resource path.
setEyesBrighteningParam(ZegoEffectsEyesBrighteningParam param) → Future<void>
Set the parameters for eyes brightening.
setEyeshadow(String name) → Future<void>
Set the eyeshadow effect.
setEyeshadowParam(ZegoEffectsEyeshadowParam param) → Future<void>
Set the parameters for the eyeshadow effect.
setEyeshadowPath(String path) → Future<void>
Set the eyeshadow effect using an absolute resource path.
setFaceLiftingParam(ZegoEffectsFaceLiftingParam param) → Future<void>
Set the parameters for face lifting.
setFaceShorteningParam(ZegoEffectsFaceShorteningParam param) → Future<void>
Set the parameters for face shortening.
setFilter(String filterName) → Future<void>
Set the filter effect.
setFilterParam(ZegoEffectsFilterParam param) → Future<void>
Set the parameters for the filter effect.
setFilterPath(String path) → Future<void>
Set the filter effect using an absolute resource path.
setForeheadShorteningParam(ZegoEffectsForeheadShorteningParam param) → Future<void>
Set the parameters for forehead shortening.
setLipstick(String name) → Future<void>
Set the lipstick effect.
setLipstickParam(ZegoEffectsLipstickParam param) → Future<void>
Set the parameters for the lipstick effect.
setLipstickPath(String path) → Future<void>
Set the lipstick effect using an absolute resource path.
setLongChinParam(ZegoEffectsLongChinParam param) → Future<void>
Set the parameters for the long chin effect.
setMakeup(String name) → Future<void>
Set the makeup effect.
setMakeupParam(ZegoEffectsMakeupParam param) → Future<void>
Set the parameters for the makeup effect.
setMakeupPath(String path) → Future<void>
Set the makeup effect using an absolute resource path.
setMandibleSlimmingParam(ZegoEffectsMandibleSlimmingParam param) → Future<void>
Set the parameters for mandible slimming.
setNoseLengtheningParam(ZegoEffectsNoseLengtheningParam param) → Future<void>
Set the parameters for nose lengthening.
setNoseNarrowingParam(ZegoEffectsNoseNarrowingParam param) → Future<void>
Set the parameters for nose narrowing.
setPendant(String pendantName) → Future<void>
Set pendant resources. Developers can call this method with a list of paths to set multiple resources, but it must be executed after SDK initialization.
setPendantPath(String path) → Future<void>
Set the pendant resources at the specified path. Developers can call this method with a list of paths to set multiple pendants, but it must be executed after SDK initialization.
setPortraitSegmentationBackgroundBlurParam(ZegoEffectsBlurParam param) → Future<void>
Set the parameters for the portrait segmentation blur background effect.
setPortraitSegmentationBackgroundMosaicParam(ZegoEffectsMosaicParam param) → Future<void>
Set the parameters for the portrait segmentation mosaic background effect. Ensure to call this method after enabling the mosaic background effect to set the appropriate mosaic effect parameters.
setPortraitSegmentationBackgroundPath(String imgPath, ZegoEffectsScaleMode mode) → Future<void>
Set the custom background image path for portrait segmentation.
setPortraitSegmentationForegroundPosition(Point<num> position, Size size) → Future<void>
Set the position and size of the portrait segmentation foreground.
setResources() → Future<void>
Set local materials or models. Developers can call this method with a list of paths to set multiple resources, but it must be executed before SDK initialization.
setResourcesPath(ZegoEffectsResourcesPathParam param) → Future<void>
Set materials or models at the specified path. Developers can call this method with a list of paths to set multiple resources, but it must be executed before SDK initialization.
setRosyParam(ZegoEffectsRosyParam param) → Future<void>
Set the parameters for the rosy effect.
setSharpenParam(ZegoEffectsSharpenParam param) → Future<void>
Set the parameters for sharpening.
setSkinColor(String name) → Future<void>
Set the skin color adjustment effect.
setSkinColorParam(ZegoEffectsSkinColorParam param) → Future<void>
Set the parameters for skin color adjustment.
setSmallMouthParam(ZegoEffectsSmallMouthParam param) → Future<void>
Set the parameters for the small mouth effect.
setSmoothParam(ZegoEffectsSmoothParam param) → Future<void>
Set the parameters for smoothing.
setTeethWhiteningParam(ZegoEffectsTeethWhiteningParam param) → Future<void>
Set the parameters for teeth whitening.
setWhitenParam(ZegoEffectsWhitenParam param) → Future<void>
Set the parameters for whitening.
setWrinklesRemovingParam(ZegoEffectsWrinklesRemovingParam param) → Future<void>
Set the parameters for wrinkle removal.
uninitEnv() → Future<void>
Uninitialize the Zego Effects environment.

Static Properties

instance → ZegoEffectsPlugin
Get the instance
final
platformVersion → Future<String>
read-only

Static Methods

destroyEventCallback() → Future<void>
Destroy event callbacks.
registerEventCallback({dynamic onEffectsError(int errorCode, String desc)?, dynamic onEffectsFaceDetected(double score, Point<num> point, Size size)?}) → Future<void>
Register event callbacks.
zegoEffectEvent() → Stream