Class

参数

详情

在调用其他函数前需要先创建并初始化 Effects 实例；SDK 支持创建多个 ZegoEffects 实例。

返回值

ZegoEffects实例对象。

参数

详情

获取 SDK 授权信息，通过授权信息和 appID 可以向 ZEGO 服务器申请鉴权文件。

返回值

授权信息。

SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。 开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

SDK 版本号。

参数

参数

详情

在调用 [enableWhiten] [enableTeethWhitening] [setPendant] 接口时，需要调用此函数设置静态资源。 支持同时设置多个资源路径。 注意：必须在创建 Effects 实例前设置。

参数

详情

在调用其他函数前需要先创建并初始化 Effects 实例；SDK 支持创建多个 ZegoEffects 实例。

返回值

ZegoEffects实例对象。

参数

详情

鉴权之后返回ZegoEffects对象。在调用其他函数前需要先创建并初始化 Effects 实例。

返回值

void

参数

详情

如果开发者需要使用到一些高级功能，人脸检测，人像分割等，就需要通过该接口设置 AI 模型，否则 AI 模型相关的功能将无法正常使用。

参数

详情

开启祛痘斑功能，可调用 [setAcneRemovingParam] 接口设置祛痘斑参数。

参数

详情

开启瘦颧骨功能，可调用 [setCheekboneSlimmingParam] 接口设置瘦颧骨参数。

参数

详情

开启清晰功能，可调用 [setClarityParam] 接口设置清晰参数。

参数

详情

开启黑眼圈去除功能，可调用 [setDarkCirclesRemovingParam] 接口设置黑眼圈去除参数。

参数

详情

开启小脸功能，可调用 [setFaceShorteningParam] 接口设置小脸参数。

参数

详情

开启缩小额头高度功能，可调用 [setForeheadShorteningParam] 接口设置缩小额头高度参数。

返回值

ZegoEffects

参数

详情

开启瘦下颌骨功能，可调用 [setMandibleSlimmingParam] 接口设置瘦下颌骨参数。

参数

详情

开启长鼻功能，可调用 [setNoseLengtheningParam] 接口设置长鼻参数。

返回值

ZegoEffects

参数

详情

开启换肤功能，可调用 [setSkinColorParam] 接口设置其参数，以及[setSkinColorResPath]接口设置对应的肤色风格。

参数

详情

开启法令纹去除功能，可调用 [setWrinklesRemovingParam] 接口设置法令纹去除参数。

SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的设备性能等级来辅助定位问题。

设备性能等级枚举，对应整型序号

参数

详情

设置祛痘斑参数。

参数

详情

开发者可调用 [setBlusherParam] 进行设置腮红参数，当设置对应腮红资源时，会自动启动腮红功能。

参数

详情

设置腮红参数。

参数

详情

设置瘦颧骨参数。

参数

详情

设置清晰参数。

参数

详情

开发者可调用 [setColoredcontactsParam] 进行设置美瞳参数，当设置对应美瞳资源时，会自动启动美妆美瞳功能。

参数

详情

设置美瞳参数。

参数

详情

设置黑眼圈去除参数。

参数

详情

开发者可调用 [setEyelinerParam] 进行设置眼线参数，当设置对应眼线资源时，会自动启动美妆眼线功能。

参数

详情

设置小脸参数。

参数

详情

设置缩小额头高度参数。

参数

详情

开发者可调用 [setMakeupParam] 进行设置风格妆参数，当设置对应风格妆资源时，会自动启动美妆风格妆功能。

参数

详情

设置风格妆参数。

参数

详情

设置瘦下颌骨参数。

参数

详情

设置长鼻参数。

参数

详情

设置换肤参数。

参数

详情

在使用换肤时，需要调用 [enableSkinColor] 启用换肤功能后该接口设置的资源才能生效。

参数

详情

设置法令纹去除参数。

用于释放 SDK 使用的资源。

参数

详情

设置事件通知回调，传 [null] 则清空已设置的回调。

参数

详情

开启亮眼, 开发者可以调用 [setEyesBrighteningParam] 来设置亮眼参数。

参数

详情

开启长下巴功能，可调用 [setLongChinParam] 接口设置长下巴参数。

参数

详情

开启红润功能，可调用 [setRosyParam] 接口设置红润参数。

参数

详情

开启锐化功能，可调用 [setSharpenParam] 接口设置锐化参数。

参数

详情

开启磨皮功能，可调用 [setSmoothParam] 接口设置磨皮参数。

参数

详情

开发者可调用 [setEyelashesParam] 进行设置眼睫毛参数，当设置对应眼睫毛资源时，会自动启动美妆眼睫毛功能。

参数

详情

设置眼睫毛参数。

参数

详情

设置眼线参数。

参数

详情

设置亮眼参数。

参数

详情

开发者可调用 [setEyeshadowParam] 进行设置眼影参数，当设置对应眼影源时，会自动启动美妆眼影功能。

参数

详情

设置眼影参数。

参数

详情

开发者可调用 [setFilterParam] 进行设置滤镜参数，当设置对应滤镜源时，会自动启动美滤镜功能。

参数

详情

设置滤镜参数。

参数

详情

开发者可调用 [setLipstickParam] 进行设置口红参数，当设置对应口红资源时，会自动启动美妆口红功能。

参数

详情

设置口红参数。

参数

详情

设置长下巴参数。

参数

详情

设置瘦鼻参数。

参数

详情

开发者可通过该接口设置不同的挂件。 注意：设置新的挂件后都会覆盖上次设置的挂件，如果需要关闭挂件请设置 [null]，挂件可能会覆盖一些美颜的效果。

参数

详情

设置红润参数。

参数

详情

设置锐化参数。

参数

详情

设置小嘴参数。

参数

详情

设置磨皮参数。

参数

详情

设置白牙参数。

参数

详情

使用后眼睛会变大。

参数

详情

设置大眼参数。

参数

详情

开启后牙齿会变得更白, 可以通过 [setTeethWhiteningParam] 接口设置参数。

参数

详情

开启美白功能。

参数

详情

设置美白参数。

参数

详情

在处理图像或视频数据前，需要调用该接口初始化 Effects 引擎环境，如果使用纹理的方式做图像处理，需要在 GL 线程调用该接口，否则会导致美颜失效。 注意：在第一次初始化时，如果有使用到 Al 相关的功能，该接口会产生耗时，请不要在主线程调用该接口，否则会造成 UI 线程卡顿。

参数

详情

设置瘦脸参数。

在停止使用摄像头进行采集时，可以调用该接口反初始化 Effects 引擎环境，反初始化会释放引擎内部一些耗资源的线程以及内存，另外反初始化后并不会释放已经加载的 Al 模型以及静态资源，只有销毁 SDK 才会释放，所以当下次再次使用 initEnv 时不会因为模型加载导致耗时。

参数

详情

启动绿幕分割后引擎会把绿色作为关键颜色，并把绿色以外的颜色进行抠图，开发者可以通过 [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] [enableChromaKeyBackgroundMosaic] 接口修改绿幕自定义背景。

参数

详情

设置绿幕分割自定义背景。

参数

详情

在使用自定义背景时，需要调用 [enableChromaKeyBackground] 启用自定义背景后该接口设置的背景才能生效。

参数

详情

开发者可以通过该接口调整绿幕容差，关键色等参数。

参数

详情

开发者还可以通过 [setChromaKeyBackgroundBuffer] [setChromaKeyBackgroundPath] [setChromaKeyBackgroundTexture] 设置绿幕自定义背景。 注意：[enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] 中的接口只能启动其中一个，其中每次 enable 后都会覆盖前一个功能。

参数

详情

开启绿幕分割背景模糊，启动后可通过 [setChromaKeyBackgroundBlurParam] 设置背景模糊参数。

参数

详情

开发者还可以通过 [setChromaKeyBackgroundMosaicParam] 设置绿幕马赛克参数。 注意：[enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] 中的接口只能启动其中一个，其中每次 enable 后都会覆盖前一个功能。

参数

详情

开启 AI 人像分割，启动后 SDK 引擎会把人像进行抠图并把背景alpha通道改成 0，开发者可以通过使用透明的背景来达到在背景播放视频的目的。 开发者还可以通过 [enablePortraitSegmentationBackground] [enablePortraitSegmentationBackgroundMosaic] [enablePortraitSegmentationBackgroundBlur] 接口来设置自定义背景或马赛克背景或高斯模糊背景。 该功能适用于在背景播放视频或在背景播放ppt等业务场景。

参数

详情

开启 AI 人像分割自定义背景，启动后可通过 [setPortraitSegmentationBackgroundTexture] [setPortraitSegmentationBackgroundPath] [setPortraitSegmentationBackgroundBuffer] 等接口设置自定义背景。 SDK 会将人像抠图，并把人像放在开发者设置的背景图片上。

参数

详情

开启 AI 人像分割背景模糊，启动后可通过 [setPortraitSegmentationBackgroundBlurParam] 设置背景模糊参数。

参数

详情

开启 Al 人像分割背景马赛克，启动后可通过 [setPortraitSegmentationBackgroundMosaicParam] 设置马赛克类型。

参数

详情

在使用背景模糊时，需要调用 [enableChromaKeyBackgroundBlur] 启用背景模糊后该接口设置的背景才能生效。

参数

详情

在使用自定义背景时，需要调用 [enableChromaKeyBackground] 启用自定义背景后该接口设置的背景才能生效。

返回值

ZegoEffects

参数

详情

需要调用 [enableChromaKeyBackgroundMosaic] 启用背景马赛克后该接口设置的背景才能生效。

参数

详情

在绿幕分割使用自定义背景时，可以通过该接口调整前景的位置坐标。

参数

详情

在使用背景模糊时，需要调用 [enablePortraitSegmentationBackgroundBlur] 启用背景模糊后该接口设置的背景才能生效。

参数

详情

在使用自定义背景时，需要调用 [enablePortraitSegmentationBackground] 启用自定义背景后该接口设置的背景才能生效。

参数

详情

需要调用 [enablePortraitSegmentationBackgroundMosaic] 启用背景马赛克后该接口设置的背景才能生效。

参数

详情

在使用自定义背景时，需要调用 [enablePortraitSegmentationBackground] 启用自定义背景后该接口设置的背景才能生效。

参数

详情

在使用自定义背景时，需要调用 [enablePortraitSegmentationBackground] 启用自定义背景后，该接口设置的背景才能生效，如果该纹理是从视频解码出来的，需要在视频纹理更新时再次调用该接口，才能刷新背景。 注意： 该接口需要在产生纹理的 GL 环境中调用，SDK才能读取到纹理内容。

参数

详情

在人像分割使用自定义背景时，可以通过该接口调整前景的位置坐标。

参数

详情

启动人脸检测后，开发者可通过 [ZegoEffectsEventHandler] 中的 [onFaceDetectionResult] 来获取人脸检测结果，包括人脸数量，人脸坐标等。

参数

详情

开启后脸会变得更苗条，下巴更瘦。

参数

详情

开启瘦鼻功能，你可以调用 [setNoseNarrowingParam] 接口来设置参数。

参数

详情

开启长小嘴功能，可调用 [setSmallMouthParam] 接口设置参数。

参数

详情

注意：在处理图像前请先调用 [initEnv] 初始化引擎环境，如果没有初始化引擎环境，会导致美颜失效。

参数

详情

注意：在处理图像前请先调用 [initEnv] 初始化引擎环境，如果没有初始化引擎环境，会导致美颜失效。

参数

详情

注意：在处理图像前请先调用 [initEnv] 初始化引擎环境，如果没有初始化引擎环境，会导致美颜失效。

返回值

effects 处理完后的 texture ID。

其他特殊功能开关，如渲染模式，设备性能等级等。如果不设置，默认不使用特殊功能。 使用前请联系ZEGO技术支持。

大眼强度，取值范围 [0~100]。

模糊强度，取值范围 [0~100]。

详情信息：腮红强度，范围 [0~100]。

腮红强度，取值范围 [0~100]。

详情信息：瘦颧骨强度，范围 [0~100]。

更新颜色容差，容差越大，被替换的范围越大，范围 [0~100] ，默认 67。

更新边缘平滑指数，越大越平滑，但渲染也会越慢，范围 [0~100] ，默认 80。

更新透明度，范围 [0~100]，默认 100 (不透明)。

更新要替换的颜色，格式：BGR，范围 [0,0xFFFFFF]，默认 0x00FF00。

更新边缘像素采样半径，borderSize 越大边缘颜色过度越平缓，速度也越慢，背景和前景交接处的像素经常会有残留绿色，取附近像素平均值作为新的像素值，来去除残留，范围 [0~100]，默认 1。

详情信息：美瞳强度，范围 [0~100]。

详情信息：黑眼圈去除强度，范围 [0~100]。

参数

详情

调用 SDK 函数出现异常时，会通过该回调提示详细的异常信息。

参数

详情

开发者可通过 [enableFaceDetection] 启动人脸检测，SDK 会将检测的人脸数据通过该回调返回。

详情信息：眼睫毛强度，范围 [0~100]。

详情信息：眼线强度，范围 [0~100]。

亮眼强度，范围 [0~100]。

详情信息：眼影强度，范围 [0~100]。

人脸的置信度, 越大表示更大概率是人脸。

人脸所在的矩形框, 完全包括了整个人脸, 单位是像素, 坐标系在输入图像的左上角。

详情信息：瘦脸强度，范围 [-100~100]。

详情信息：小脸强度，范围 [0~100]。

详情信息：开发者可通过该属性调整滤镜强度。

缩小额头高度强度，范围 [-100~100]。

详情信息：口红强度，范围 [0~100]。

长下巴强度，范围 [-100~100]。

详情信息：风格妆强度，范围 [0~100]。

详情信息：瘦下颌骨强度，范围 [0~100]。

马赛克强度 [0~100]。

设置马赛克类型，默认为三角形。

详情信息：长鼻强度，范围 [-100~100]。

瘦鼻强度，范围 [0-100]。

原点的 x 值。

原点的 Y 值。

矩形的宽度，单位为像素。

矩形的高度，单位为像素。

详情信息：红润强度，范围 [0~100]。

详情信息：锐化强度，范围 [0~100]。

详情信息：小嘴强度，范围 [-100~100]。

详情信息：磨皮强度，范围 [0~100]。

详情信息：白牙强度，范围 [0~100]。

视频帧宽度，单位为像素。

视频帧高度，单位为像素。

视频数据帧格式。

纹理格式，如果是传递纹理，可以指定对应纹理的格式，2D 纹理还是 OES 纹理（ Android 特有格式）。

2D 纹理是 OES 纹理（ Android 特有格式）时，传入纹理变换矩阵，可以从SurfaceTexture的getTransformMatrix(float[] mtx)接口获取。

美白强度，范围 [0~100]。

详情信息：法令纹去除强度，范围 [-100~100]。