ZegoEffectsPlugin class Null safety
Methods
-
create(
int appID, String appSign) → Future< int> - 根据鉴权创建 Zego Effects SDK,鉴权由内部处理,用户只需传 appID 和 appSign 即可。
-
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 服务器申请鉴权文件
-
getResourcesFolder(
) → Future< String> - 获取当前设备的资源路径。
-
getVersion(
) → Future< String> - 获取当前 Effects SDK 版本
-
initEnv(
Size resolution) → Future< int> - 初始化 Zego Effects 环境,并设置期望的分辨率。
-
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 初始化之后执行。
-
setPendantPath(
String path) → Future< void> - 设置指定路径的挂件资源。开发者可以通过使用路径列表调用此方法来设置多个挂件,但需要在 SDK 初始化之后执行。
-
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 初始化之前执行。
-
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> - 设置去皱纹功能的参数。
-
uninitEnv(
) → Future< void> - 反初始化 Zego Effects 环境。
Static Properties
- instance → ZegoEffectsPlugin
-
获取实例
final
-
platformVersion
→ Future<
String> -
read-only
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