ZegoEffectsPlugin class

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create(int appID, String appSign) → Future<int>

根据鉴权创建 Zego Effects SDK，鉴权由内部处理，用户只需传appID和appSign即可。 @param {int} appID 申请的appID @param {String} appSign 申请的appSign @returns 返回创建状态。状态为0时表示成功，其他则失败。 @example ZegoEffectsPlugin.instance.create(0, "").then((result) {});

destroy() → Future<void>

销毁 Zego Effects SDK 实例。 该方法用于释放与 Zego Effects SDK 相关的资源，确保在不再需要使用 SDK 时能够正确清理。

enableAcneRemoving(bool enable) → Future<void>

启用祛痘功能。

enableBigEyes(bool enable) → Future<void>

启用大眼功能。

enableCheekboneSlimming(bool enable) → Future<void>

启用颧骨瘦脸功能。

enableChromaKey(bool enable) → Future<void>

启用抠像功能。

enableChromaKeyBackground(bool enable) → Future<void>

启用抠像背景。

enableChromaKeyBackgroundBlur(bool enable) → Future<void>

启用抠像模糊背景功能。

enableChromaKeyBackgroundMosaic(bool enable) → Future<void>

启用抠像马赛克背景。

enableClarity(bool enable) → Future<void>

启用清晰度功能。

enableDarkCirclesRemoving(bool enable) → Future<void>

启用去黑眼圈功能。

enableEyesBrightening(bool enable) → Future<void>

启用眼睛提亮功能。

enableFaceDetection(bool enable) → Future<void>

启用人脸检测功能。

enableFaceLifting(bool enable) → Future<void>

启用人脸微整形功能。

enableFaceShortening(bool enable) → Future<void>

启用脸型缩短功能。

enableForeheadShortening(bool enable) → Future<void>

启用额头缩短功能。

enableImageProcessing(bool enable) → Future<void>

启用或禁用自定义图像处理和效果。

enableLongChin(bool enable) → Future<void>

启用长下巴功能。

enableMandibleSlimming(bool enable) → Future<void>

启用下颌瘦脸功能。

enableNoseLengthening(bool enable) → Future<void>

启用鼻子拉长功能。

enableNoseNarrowing(bool enable) → Future<void>

启用鼻子瘦化功能。

enablePortraitSegmentation(bool enable) → Future<void>

启用或禁用人像分割功能。

enablePortraitSegmentationBackground(bool enable) → Future<void>

启用人像分割功能。

enablePortraitSegmentationBackgroundBlur(bool enable) → Future<void>

启用人像分割功能，并设置背景为模糊效果。

enablePortraitSegmentationBackgroundMosaic(bool enable) → Future<void>

启用人像分割功能，并设置背景为马赛克效果。

enableRosy(bool enable) → Future<void>

启用红润功能。

enableSharpen(bool enable) → Future<void>

启用锐化功能。

enableSkinColor(bool enable) → Future<void>

启用肤色调整功能。

enableSmallMouth(bool enable) → Future<void>

启用小口功能。

enableSmooth(bool enable) → Future<void>

启用磨皮功能。

enableTeethWhitening(bool enable) → Future<void>

启用牙齿美白功能。

enableWhiten(bool enable) → Future<void>

启用美白功能。

enableWrinklesRemoving(bool enable) → Future<void>

启用去皱纹功能。

getAuthInfo(String appSign) → Future<String>

获取 SDK 授权信息，通过授权信息和 appID 可以向 ZEGO 服务器申请鉴权文件 @param {String} appSign 每个 AppID 对应的应用签名。该参数为包含 64 个字符的字符串，字符取值范围：'0' ~ '9', 'a' ~ 'z' @returns 授权信息 @example ZegoEffectsPlugin.instance.getAuthInfo(appSign).then((authInfo) {});

getResourcesFolder() → Future<String>

获取当前设备的资源路径。 @returns 资源路径。

getVersion() → Future<String>

获取当前 Effects SDK 版本 @returns 当前 Effects SDK 版本

initEnv(Size resolution) → Future<int>

初始化 Zego Effects 环境，并设置期望的分辨率。

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setAcneRemovingParam(ZegoEffectsAcneRemovingParam param) → Future<void>

设置祛痘功能的参数。

setBigEyesParam(ZegoEffectsBigEyesParam param) → Future<void>

设置大眼功能的参数。

setBlusher(String name) → Future<void>

设置腮红功能。

setBlusherParam(ZegoEffectsBlusherParam param) → Future<void>

设置腮红功能的参数。

setBlusherPath(String path) → Future<void>

使用绝对资源路径设置腮红功能。

setCheekboneSlimmingParam(ZegoEffectsCheekboneSlimmingParam param) → Future<void>

设置颧骨瘦脸功能的参数。

setChromaKeyBackgroundBlurParam(ZegoEffectsBlurParam param) → Future<void>

设置抠像模糊背景的参数。

setChromaKeyBackgroundMosaicParam(ZegoEffectsMosaicParam param) → Future<void>

设置抠像马赛克背景的参数。

setChromaKeyBackgroundPath(String imagePath, ZegoEffectsScaleMode mode) → Future<void>

设置抠像自定义背景的路径。

setChromaKeyForegroundPosition(double x, double y, double width, double height) → Future<void>

设置抠像前景的位置和大小。

setChromaKeyParam(ZegoEffectsChromaKeyParam param) → Future<void>

设置抠像功能的参数。

setClarityParam(ZegoEffectsClarityParam param) → Future<void>

设置清晰度功能的参数。

setColoredcontacts(String name) → Future<void>

设置有色隐形眼镜功能。

setColoredcontactsParam(ZegoEffectsColoredcontactsParam param) → Future<void>

设置有色隐形眼镜功能的参数。

setColoredcontactsPath(String path) → Future<void>

使用绝对资源路径设置有色隐形眼镜功能。

setDarkCirclesRemovingParam(ZegoEffectsDarkCirclesRemovingParam param) → Future<void>

设置去黑眼圈功能的参数。

setEyelashes(String name) → Future<void>

设置睫毛功能。

setEyelashesParam(ZegoEffectsEyelashesParam param) → Future<void>

设置睫毛功能的参数。

setEyelashesPath(String path) → Future<void>

使用绝对资源路径设置睫毛功能。

setEyeliner(String name) → Future<void>

设置眼线功能。

setEyelinerParam(ZegoEffectsEyelinerParam param) → Future<void>

设置眼线功能的参数。

setEyelinerPath(String path) → Future<void>

使用绝对资源路径设置眼线功能。

setEyesBrighteningParam(ZegoEffectsEyesBrighteningParam param) → Future<void>

设置眼睛提亮功能的参数。

setEyeshadow(String name) → Future<void>

设置眼影功能。

setEyeshadowParam(ZegoEffectsEyeshadowParam param) → Future<void>

设置眼影功能的参数。

setEyeshadowPath(String path) → Future<void>

使用绝对资源路径设置眼影功能。

setFaceLiftingParam(ZegoEffectsFaceLiftingParam param) → Future<void>

设置人脸微整形功能的参数。

setFaceShorteningParam(ZegoEffectsFaceShorteningParam param) → Future<void>

设置脸型缩短功能的参数。

setFilter(String filterName) → Future<void>

设置滤镜功能。

setFilterParam(ZegoEffectsFilterParam param) → Future<void>

设置滤镜功能的参数。

setFilterPath(String path) → Future<void>

设置滤镜功能，使用绝对资源路径。

setForeheadShorteningParam(ZegoEffectsForeheadShorteningParam param) → Future<void>

设置额头缩短功能的参数。

setLipstick(String name) → Future<void>

设置口红功能。

setLipstickParam(ZegoEffectsLipstickParam param) → Future<void>

设置口红功能的参数。

setLipstickPath(String path) → Future<void>

使用绝对资源路径设置口红功能。

setLongChinParam(ZegoEffectsLongChinParam param) → Future<void>

设置长下巴功能的参数。

setMakeup(String name) → Future<void>

设置妆容功能。

setMakeupParam(ZegoEffectsMakeupParam param) → Future<void>

设置妆容功能的参数。

setMakeupPath(String path) → Future<void>

使用绝对资源路径设置妆容功能。

setMandibleSlimmingParam(ZegoEffectsMandibleSlimmingParam param) → Future<void>

设置下颌瘦脸功能的参数。

setNoseLengtheningParam(ZegoEffectsNoseLengtheningParam param) → Future<void>

设置鼻子拉长功能的参数。

setNoseNarrowingParam(ZegoEffectsNoseNarrowingParam param) → Future<void>

设置鼻子瘦化功能的参数。

setPendant(String pendantName) → Future<void>

设置挂件资源。开发者可以通过使用路径列表调用此方法来设置多个资源，但需要在 SDK 初始化之后执行。 @param {String} pendantName 挂件资源路径

setPendantPath(String path) → Future<void>

设置指定路径的挂件资源。开发者可以通过使用路径列表调用此方法来设置多个挂件，但需要在 SDK 初始化之后执行。 @param {String} param 各项挂件路径 @example ZegoEffectsPlugin.instance.setResourcesPath("pendant.bundle");

setPortraitSegmentationBackgroundBlurParam(ZegoEffectsBlurParam param) → Future<void>

设置人像分割背景模糊效果的参数。

setPortraitSegmentationBackgroundMosaicParam(ZegoEffectsMosaicParam param) → Future<void>

设置人像分割背景马赛克效果的参数。

setPortraitSegmentationBackgroundPath(String imgPath, ZegoEffectsScaleMode mode) → Future<void>

设置人像分割的自定义背景图片路径。

setPortraitSegmentationForegroundPosition(Point<num> position, Size size) → Future<void>

设置人像分割前景的位置和大小。

setResources() → Future<void>

设置本地素材或模型。开发者可以通过使用路径列表调用此方法来设置多个资源，但需要在 SDK 初始化之前执行。

setResourcesPath(ZegoEffectsResourcesPathParam param) → Future<void>

设置指定路径的素材或模型。开发者可以通过使用路径列表调用此方法来设置多个资源，但需要在 SDK 初始化之前执行。 @param {ZegoEffectsResourcesPathParam} param 各项效果的素材或模型路径 @example final param = ZegoEffectsResourcesPathParam(); param.common = "commonResources.bundle"; param.faceDetection = "faceDetection.model"; param.segmentation = "segmentation.model"; ZegoEffectsPlugin.instance.setResourcesPath(param);

setRosyParam(ZegoEffectsRosyParam param) → Future<void>

设置红润功能的参数。

setSharpenParam(ZegoEffectsSharpenParam param) → Future<void>

设置锐化功能的参数。

setSkinColor(String name) → Future<void>

设置肤色调整功能。

setSkinColorParam(ZegoEffectsSkinColorParam param) → Future<void>

设置肤色调整功能的参数。

setSmallMouthParam(ZegoEffectsSmallMouthParam param) → Future<void>

设置小口功能的参数。

setSmoothParam(ZegoEffectsSmoothParam param) → Future<void>

设置磨皮功能的参数。

setTeethWhiteningParam(ZegoEffectsTeethWhiteningParam param) → Future<void>

设置牙齿美白功能的参数。

setWhitenParam(ZegoEffectsWhitenParam param) → Future<void>

设置美白功能的参数。

setWrinklesRemovingParam(ZegoEffectsWrinklesRemovingParam param) → Future<void>

设置去皱纹功能的参数。

toString() → String

A string representation of this object.

inherited

uninitEnv() → Future<void>

反初始化 Zego Effects 环境。

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance → ZegoEffectsPlugin

Get the instance of ZegoEffectsPlugin

final

platformVersion → Future<String>

no setter

Static Methods

destroyEventCallback() → Future<void>

销毁事件回调。

registerEventCallback({dynamic onEffectsError(int errorCode, String desc)?, dynamic onEffectsFaceDetected(double score, Point<num> point, Size size)?}) → Future<void>

注册事件回调。

zegoEffectEvent() → Stream