Class
ZegoEffects
AI 美颜相关接口
详情
AI 美颜相关接口
Declared in ZegoEffects.h
方法
create:appid:appSign:
+ (ZegoEffects)public create:(NSInteger) appid appSign:(NSString *) appSign;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| appid | NSInteger | appid |
| appSign | NSString * | appSign |
详情
在调用其他函数前需要先创建并初始化 Effects 实例；SDK 支持创建多个 ZegoEffects 实例。
- 支持版本：2.2.0 或以上。
返回值
ZegoEffects实例对象。
getAuthInfo:appSign:
+ (NNString*)getAuthInfo:(NNString*) appSign;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| appSign | NNString* | 每个 AppID 对应的应用签名。该参数为包含 64 个字符的字符串，字符取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。 |
详情
获取 SDK 授权信息，通过授权信息和 appID 可以向 ZEGO 服务器申请鉴权文件。
返回值
授权信息。
getVersion
+ (NSString *)getVersion;ZegoEffects.hSDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。 开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。
SDK 版本号。
setAdvancedConfig:config:
+ (void)setAdvancedConfig:(ZegoEffectsAdvancedConfig) config;ZegoEffects.hsetResources:resourceInfoList:
+ (void)setResources:(nullable NSArray<NSString*> *) resourceInfoList;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| resourceInfoList | nullable NSArray<NSString*> * | 资源列表。 |
详情
在调用 [enableWhiten] [enableTeethWhitening] [setPendant] 接口时，需要调用此函数设置静态资源。 支持同时设置多个资源路径。 注意：必须在创建 Effects 实例前设置。
create:license:
+ (ZegoEffects)public create:(NSString *) license;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| license | NSString * | 鉴权证书文件。 |
详情
在调用其他函数前需要先创建并初始化 Effects 实例；SDK 支持创建多个 ZegoEffects 实例。
返回值
ZegoEffects实例对象。
create:appid:appSign:callback:
+ (void)create:(NSInteger) appid appSign:(NSString) appSign callback:(void (^)(ZegoEffects, NSInteger)) callback;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| appid | NSInteger | SDK 鉴权 AppID。 |
| appSign | NSString | SDK 鉴权 AppSign。 |
| callback | void (^)(ZegoEffects, NSInteger) | 创建实例请求的结果回调。回调包含 ZegoEffects 对象和鉴权错误码https://doc-zh.zego.im/article/9587。 |
详情
鉴权之后返回ZegoEffects对象。在调用其他函数前需要先创建并初始化 Effects 实例。
- 支持版本：2.1.0或以上。
- 注意事项：返回ZegoEffects对象由回调返回。
返回值
void
setModels:modelInfoList:
+ (void)setModels:(NSArray<NSString*> *) modelInfoList;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| modelInfoList | NSArray<NSString*> * | ai模型路径 |
详情
如果开发者需要使用到一些高级功能，人脸检测，人像分割等，就需要通过该接口设置 AI 模型，否则 AI 模型相关的功能将无法正常使用。
- 调用时机/通知时机：全局生效，必须在创建 Effects 实例前设置。
enableAcneRemoving:enable:
- (ZegoEffects)public enableAcneRemoving:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动祛痘斑功能；[true] 表示启动该功能，[false] 表示关闭该功能。默认值为 [false]。 |
详情
开启祛痘斑功能，可调用 [setAcneRemovingParam] 接口设置祛痘斑参数。
enableCheekboneSlimming:enable:
- (ZegoEffects)public enableCheekboneSlimming:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动瘦颧骨功能；[true] 表示启动瘦颧骨功能；[false] 表示关闭瘦颧骨功能。默认值为 [false]。 |
详情
开启瘦颧骨功能，可调用 [setCheekboneSlimmingParam] 接口设置瘦颧骨参数。
enableClarity:enable:
- (ZegoEffects)public enableClarity:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动清晰功能；[true] 表示启动该功能，[false] 表示关闭该功能。默认值为 [false]。 |
详情
开启清晰功能，可调用 [setClarityParam] 接口设置清晰参数。
enableDarkCirclesRemoving:enable:
- (ZegoEffects)public enableDarkCirclesRemoving:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动去除黑眼圈功能；[true] 表示启动去除黑眼圈功能；[false] 表示关闭去除黑眼圈功能。默认值为 [false]。 |
详情
开启黑眼圈去除功能，可调用 [setDarkCirclesRemovingParam] 接口设置黑眼圈去除参数。
enableFaceShortening:enable:
- (ZegoEffects)public enableFaceShortening:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动小脸功能；[true] 表示启动小脸功能；[false] 表示关闭小脸功能。默认值为 [false]。 |
详情
开启小脸功能，可调用 [setFaceShorteningParam] 接口设置小脸参数。
enableForeheadShortening:enable:
- (ZegoEffects)public enableForeheadShortening:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动缩小额头高度功能；[true] 表示启动缩小额头高度功能；[false] 表示关闭缩小额头高度功能。默认值为 [false]。 |
详情
开启缩小额头高度功能，可调用 [setForeheadShorteningParam] 接口设置缩小额头高度参数。
返回值
ZegoEffects
enableMandibleSlimming:enable:
- (ZegoEffects)public enableMandibleSlimming:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动瘦下颌骨功能；[true] 表示启动瘦下颌骨功能；[false] 表示关闭瘦下颌骨功能。默认值为 [false]。 |
详情
开启瘦下颌骨功能，可调用 [setMandibleSlimmingParam] 接口设置瘦下颌骨参数。
enableNoseLengthening:enable:
- (ZegoEffects)public enableNoseLengthening:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动长鼻功能；[true] 表示启动长鼻功能；[false] 表示关闭长鼻功能。默认值为 [false]。 |
详情
开启长鼻功能，可调用 [setNoseLengtheningParam] 接口设置长鼻参数。
返回值
ZegoEffects
enableSkinColor:enable:
- (ZegoEffects)public enableSkinColor:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动换肤功能；[true] 表示启动该功能，[false] 表示关闭该功能。默认值为 [false]。 |
详情
开启换肤功能，可调用 [setSkinColorParam] 接口设置其参数，以及[setSkinColorResPath]接口设置对应的肤色风格。
enableWrinklesRemoving:enable:
- (ZegoEffects)public enableWrinklesRemoving:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动去法令纹功能；[true] 表示启动去法令纹功能；[false] 表示关闭去法令纹功能。默认值为 [false]。 |
详情
开启法令纹去除功能，可调用 [setWrinklesRemovingParam] 接口设置法令纹去除参数。
getDeviceLevel
- (ZegoEffectsDeviceLevel)public getDeviceLevel;ZegoEffects.hSDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的设备性能等级来辅助定位问题。
设备性能等级枚举，对应整型序号
setAcneRemovingParam:param:
- (ZegoEffects)public setAcneRemovingParam:(ZegoEffectsAcneRemovingParam) param;setBlusher:path:
- (ZegoEffects)public setBlusher:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 腮红资源的绝对路径。 |
详情
开发者可调用 [setBlusherParam] 进行设置腮红参数，当设置对应腮红资源时，会自动启动腮红功能。
- 支持版本：1.4.0。
setBlusherParam:param:
- (ZegoEffects)public setBlusherParam:(ZegoEffectsBlusherParam) param;setCheekboneSlimmingParam:param:
- (ZegoEffects)public setCheekboneSlimmingParam:(ZegoEffectsCheekboneSlimmingParam) param;setClarityParam:param:
- (ZegoEffects)public setClarityParam:(ZegoEffectsClarityParam) param;setColoredcontacts:path:
- (void)setColoredcontacts:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 美瞳资源的绝对路径。 |
详情
开发者可调用 [setColoredcontactsParam] 进行设置美瞳参数，当设置对应美瞳资源时，会自动启动美妆美瞳功能。
- 支持版本：1.4.0。
setColoredcontactsParam:param:
- (ZegoEffects) setColoredcontactsParam:(ZegoEffectsColoredcontactsParam) param;setDarkCirclesRemovingParam:param:
- (ZegoEffects)public setDarkCirclesRemovingParam:(ZegoEffectsDarkCirclesRemovingParam) param;ZegoEffects.hsetEyeliner:path:
- (ZegoEffects)public setEyeliner:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 眼线资源的绝对路径。 |
详情
开发者可调用 [setEyelinerParam] 进行设置眼线参数，当设置对应眼线资源时，会自动启动美妆眼线功能。
- 支持版本：1.4.0。
setFaceShorteningParam:param:
- (ZegoEffects)public setFaceShorteningParam:(ZegoEffectsFaceShorteningParam) param;setForeheadShorteningParam:param:
- (ZegoEffects) setForeheadShorteningParam:(ZegoEffectsForeheadShorteningParam) param;ZegoEffects.hsetMakeup:path:
- (ZegoEffects)public setMakeup:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 风格妆资源的绝对路径。 |
详情
开发者可调用 [setMakeupParam] 进行设置风格妆参数，当设置对应风格妆资源时，会自动启动美妆风格妆功能。
- 支持版本：1.4.0。
setMakeupParam:param:
- (ZegoEffects)public setMakeupParam:(ZegoEffectsMakeupParam) param;setMandibleSlimmingParam:param:
- (ZegoEffects)public setMandibleSlimmingParam:(ZegoEffectsMandibleSlimmingParam) param;setNoseLengtheningParam:param:
- (ZegoEffects)public setNoseLengtheningParam:(ZegoEffectsNoseLengtheningParam) param;setSkinColorParam:param:
- (ZegoEffects)public setSkinColorParam:(ZegoEffectsSkinColorParam) param;setSkinColorResPath:bundlePath:
- (ZegoEffects)public setSkinColorResPath:(NSString *) bundlePath;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| bundlePath | NSString * | 换肤功能资源路径参数。 |
详情
在使用换肤时，需要调用 [enableSkinColor] 启用换肤功能后该接口设置的资源才能生效。
setWrinklesRemovingParam:param:
- (ZegoEffects)public setWrinklesRemovingParam:(ZegoEffectsWrinklesRemovingParam) param;ZegoEffects.hdestroy
- (void)destroy;ZegoEffects.h用于释放 SDK 使用的资源。
setEventHandler:eventHandler:
- (ZegoEffects)public setEventHandler:(nullable id<ZegoEffectsEventHandler>) eventHandler;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| eventHandler | nullable id<ZegoEffectsEventHandler> | 事件通知回调。开发者应根据自身业务场景，重写回调的相关方法以关注特定的通知。SDK 主要的回调方法都在 [ZegoEffectsEventHandler] 里。 |
详情
设置事件通知回调，传 [nil] 则清空已设置的回调。
enableEyesBrightening:enable:
- (ZegoEffects)public enableEyesBrightening:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动亮眼功能；[true] 表示启动亮眼功能；[false] 表示关闭亮眼功能。默认值为 [false]。 |
详情
开启亮眼, 开发者可以调用 [setEyesBrighteningParam] 来设置亮眼参数。
enableLongChin:enable:
- (ZegoEffects)public enableLongChin:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动长下巴功能；[true] 表示启动长下巴功能；[false] 表示关闭长下巴功能。默认值为 [false]。 |
详情
开启长下巴功能，可调用 [setLongChinParam] 接口设置长下巴参数。
enableRosy:enable:
- (ZegoEffects)public enableRosy:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动红润功能；[true] 表示启动红润功能；[false] 表示关闭红润功能。默认值为 [false]。 |
详情
开启红润功能，可调用 [setRosyParam] 接口设置红润参数。
enableSharpen:enable:
- (ZegoEffects)public enableSharpen:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动锐化功能；[true] 表示启动锐化功能；[false] 表示关闭锐化功能。默认值为 [false]。 |
详情
开启锐化功能，可调用 [setSharpenParam] 接口设置锐化参数。
enableSmooth:enable:
- (ZegoEffects)public enableSmooth:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动磨皮功能；[true] 表示启动磨皮功能；[false] 表示关闭磨皮功能。默认值为 [false]。 |
详情
开启磨皮功能，可调用 [setSmoothParam] 接口设置磨皮参数。
setEyelashes:path:
- (ZegoEffects)public setEyelashes:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 眼睫毛资源的绝对路径。 |
详情
开发者可调用 [setEyelashesParam] 进行设置眼睫毛参数，当设置对应眼睫毛资源时，会自动启动美妆眼睫毛功能。
- 支持版本：1.4.0。
setEyelashesParam:param:
- (ZegoEffects)public setEyelashesParam:(ZegoEffectsEyelashesParam) param;setEyelinerParam:param:
- (ZegoEffects)public setEyelinerParam:(ZegoEffectsEyelinerParam) param;setEyesBrighteningParam:param:
- (ZegoEffects)public setEyesBrighteningParam:(ZegoEffectsEyesBrighteningParam) param;setEyeshadow:path:
- (ZegoEffects)public setEyeshadow:(NNString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NNString | 眼影资源的绝对路径。 |
详情
开发者可调用 [setEyeshadowParam] 进行设置眼影参数，当设置对应眼影源时，会自动启动美妆眼影功能。
- 支持版本：1.4.0。
setEyeshadowParam:param:
- (ZegoEffects)public setEyeshadowParam:(ZegoEffectsEyeshadowParam) param;setFilter:path:
- (ZegoEffects)public setFilter:(NSString *) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NSString * | 滤镜资源的绝对路径。 |
详情
开发者可调用 [setFilterParam] 进行设置滤镜参数，当设置对应滤镜源时，会自动启动美滤镜功能。
- 支持版本：1.1.0
setFilterParam:param:
- (ZegoEffects)public setFilterParam:(ZegoEffectsFilterParam) param;setLipstick:path:
- (ZegoEffects)public setLipstick:(NSString) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NSString | 口红资源的绝对路径。 |
详情
开发者可调用 [setLipstickParam] 进行设置口红参数，当设置对应口红资源时，会自动启动美妆口红功能。
- 支持版本：1.4.0。
setLipstickParam:param:
- (ZegoEffects)public setLipstickParam:(ZegoEffectsLipstickParam) param;setLongChinParam:param:
- (ZegoEffects)public setLongChinParam:(ZegoEffectsLongChinParam) param;setNoseNarrowingParam:param:
- (ZegoEffects)public setNoseNarrowingParam:(ZegoEffectsNoseNarrowingParam) param;setPendant:path:
- (ZegoEffects)public setPendant:(NSString *) path;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| path | NSString * | 挂件的绝对路径。 |
详情
开发者可通过该接口设置不同的挂件。 注意：设置新的挂件后都会覆盖上次设置的挂件，如果需要关闭挂件请设置 [nil]，挂件可能会覆盖一些美颜的效果。
setRosyParam:param:
- (ZegoEffects)public setRosyParam:(ZegoEffectsRosyParam) param;setSharpenParam:param:
- (ZegoEffects)public setSharpenParam:(ZegoEffectsSharpenParam) param;setSmallMouthParam:param:
- (ZegoEffects)public setSmallMouthParam:(ZegoEffectsSmallMouthParam) param;setSmoothParam:param:
- (ZegoEffects)public setSmoothParam:(ZegoEffectsSmoothParam) param;setTeethWhiteningParam:param:
- (ZegoEffects)public setTeethWhiteningParam:(ZegoEffectsTeethWhiteningParam) param;enableBigEyes:enable:
- (ZegoEffects)public enableBigEyes:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动大眼功能；[true] 表示启动大眼功能；[false] 表示关闭大眼功能。默认值为 [false]。 |
详情
使用后眼睛会变大。
setBigEyesParam:param:
- (ZegoEffects)public setBigEyesParam:(ZegoEffectsBigEyesParam) param;enableTeethWhitening:enable:
- (ZegoEffects)public enableTeethWhitening:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动白牙功能；[true] 表示启动白牙功能；[false] 表示关闭白牙功能。默认值为 [false]。 |
详情
开启后牙齿会变得更白, 可以通过 [setTeethWhiteningParam] 接口设置参数。
enableWhiten:enable:
- (ZegoEffects)public enableWhiten:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动美白功能；[true] 表示启动美白功能；[false] 表示关闭美白功能。默认值为 [false]。 |
详情
开启美白功能。
setWhitenParam:param:
- (ZegoEffects)public setWhitenParam:(ZegoEffectsWhitenParam) param;initEnv:resolution:
- (void)initEnv:(CGSize) resolution;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| resolution | CGSize | 画面分辨率。 |
详情
在处理图像或视频数据前，需要调用该接口初始化 Effects 引擎环境。 注意：在第一次初始化时，如果有使用到 Al 相关的功能，该接口会产生耗时，请不要在主线程调用该接口，否则会造成 UI 线程卡顿。
setFaceLiftingParam:param:
- (ZegoEffects)public setFaceLiftingParam:(ZegoEffectsFaceLiftingParam) param;uninitEnv
- (void)uninitEnv;ZegoEffects.h在停止使用摄像头进行采集时，可以调用该接口反初始化 Effects 引擎环境，反初始化会释放引擎内部一些耗资源的线程以及内存，另外反初始化后并不会释放已经加载的 Al 模型以及静态资源，只有销毁 SDK 才会释放，所以当下次再次使用 initEnv 时不会因为模型加载导致耗时。
enableChromaKey:enable:
- (ZegoEffects)public enableChromaKey:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动绿幕分割功能；[true] 表示启动绿幕分割功能；[false] 表示关闭绿幕功能。默认值为 [false]。 |
详情
启动绿幕分割后引擎会把绿色作为关键颜色，并把绿色以外的颜色进行抠图，开发者可以通过 [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] [enableChromaKeyBackgroundMosaic] 接口修改绿幕自定义背景。
setChromaKeyBackgroundPath:imagePath:mode:
- (ZegoEffects)public setChromaKeyBackgroundPath:(NSString *) imagePath mode:(ZegoEffectsScaleMode) mode;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| imagePath | NSString * | 图片路径。 |
| mode | ZegoEffectsScaleMode | 显示的视图模式。 |
详情
在使用自定义背景时，需要调用 [enableChromaKeyBackground] 启用自定义背景后该接口设置的背景才能生效。
setChromaKeyParam:param:
- (ZegoEffects)public setChromaKeyParam:(ZegoEffectsChromaKeyParam) param;ZegoEffects.henableChromaKeyBackground:enable:
- (ZegoEffects)public enableChromaKeyBackground:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动绿幕分割自定义背景功能；[true] 表示启动绿幕分割自定义背景功能；[false] 表示关闭绿幕分割自定义背景功能。默认值为 [false]。 |
详情
开发者还可以通过 [setChromaKeyBackgroundBuffer] [setChromaKeyBackgroundPath] [setChromaKeyBackgroundTexture] 设置绿幕自定义背景。 注意：[enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] 中的接口只能启动其中一个，其中每次 enable 后都会覆盖前一个功能。
enableChromaKeyBackgroundBlur:enable:
- (ZegoEffects)public enableChromaKeyBackgroundBlur:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动绿幕背景分割功能；[true] 表示启动绿幕背景分割功能；[false] 表示关闭绿幕背景分割功能。默认值为 [false]。 |
详情
开启绿幕分割背景模糊，启动后可通过 [setChromaKeyBackgroundBlurParam] 设置背景模糊参数。
enableChromaKeyBackgroundMosaic:enable:
- (ZegoEffects)public enableChromaKeyBackgroundMosaic:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动绿幕背景马赛克功能；[true] 表示启动绿幕背景马赛克功能；[false] 表示关闭绿幕背景马赛克功能。默认值为 [false]。 |
详情
开发者还可以通过 [setChromaKeyBackgroundMosaicParam] 设置绿幕马赛克参数。 注意：[enableChromaKeyBackgroundMosaic] [enableChromaKeyBackground] [enableChromaKeyBackgroundBlur] 中的接口只能启动其中一个，其中每次 enable 后都会覆盖前一个功能。
enablePortraitSegmentation:enable:
- (ZegoEffects)public enablePortraitSegmentation:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动人像分割功能；[true] 表示启动人像分割功能；[false] 表示关闭人像分割功能。默认值为 [false]。 |
详情
开启 AI 人像分割，启动后 SDK 引擎会把人像进行抠图并把背景alpha通道改成 0，开发者可以通过使用透明的背景来达到在背景播放视频的目的。 开发者还可以通过 [enablePortraitSegmentationBackground] [enablePortraitSegmentationBackgroundMosaic] [enablePortraitSegmentationBackgroundBlur] 接口来设置自定义背景或马赛克背景或高斯模糊背景。 该功能适用于在背景播放视频或在背景播放ppt等业务场景。
enablePortraitSegmentationBackground:enable:
- (ZegoEffects)public enablePortraitSegmentationBackground:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动AI人像分割自定义背景功能；[true] 表示启动AI人像分割自定义背景功能；[false] 表示关闭AI人像分割自定义背景功能。默认值为 [false]。 |
详情
开启 AI 人像分割自定义背景，启动后可通过 [setPortraitSegmentationBackgroundTexture] [setPortraitSegmentationBackgroundPath] [setPortraitSegmentationBackgroundBuffer] 等接口设置自定义背景。 SDK 会将人像抠图，并把人像放在开发者设置的背景图片上。
enablePortraitSegmentationBackgroundBlur:enable:
- (ZegoEffects)public enablePortraitSegmentationBackgroundBlur:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动人像分割背景模糊功能；[true] 表示启动人像分割背景模糊功能；[false] 表示关闭人像分割背景模糊功能。默认值为 [false]。 |
详情
开启 AI 人像分割背景模糊，启动后可通过 [setPortraitSegmentationBackgroundBlurParam] 设置背景模糊参数。
enablePortraitSegmentationBackgroundMosaic:enable:
- (ZegoEffects)public enablePortraitSegmentationBackgroundMosaic:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动人像分割背景马赛克功能；[true] 表示启动人像分割背景马赛克功能；[false] 表示关闭人像分割背景马赛克功能。默认值为 [false]。 |
详情
开启 Al 人像分割背景马赛克，启动后可通过 [setPortraitSegmentationBackgroundMosaicParam] 设置马赛克类型。
setChromaKeyBackgroundBlurParam:param:
- (ZegoEffects)public setChromaKeyBackgroundBlurParam:(ZegoEffectsBlurParam) param;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| param | ZegoEffectsBlurParam | 绿幕背景模糊功能参数。 |
详情
在使用背景模糊时，需要调用 [enableChromaKeyBackgroundBlur] 启用背景模糊后该接口设置的背景才能生效。
setChromaKeyBackgroundBuffer:buffer:mode:
- (ZegoEffects)public setChromaKeyBackgroundBuffer:(CVPixelBufferRef) buffer mode:(ZegoEffectsScaleMode) mode;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| buffer | CVPixelBufferRef | 图片帧数据。 |
| mode | ZegoEffectsScaleMode | 显示的视图模式。 |
详情
在使用自定义背景时，需要调用 [enableChromaKeyBackground] 启用自定义背景后该接口设置的背景才能生效。
返回值
ZegoEffects
setChromaKeyBackgroundMosaicParam:param:
- (ZegoEffects)public setChromaKeyBackgroundMosaicParam:(ZegoEffectsMosaicParam) param;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| param | ZegoEffectsMosaicParam | 马赛克参数。 |
详情
需要调用 [enableChromaKeyBackgroundMosaic] 启用背景马赛克后该接口设置的背景才能生效。
setChromaKeyForegroundPosition:rect:
- (ZegoEffects)public setChromaKeyForegroundPosition:(CGRect) rect;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| rect | CGRect | 前景的位置坐标。 |
详情
在绿幕分割使用自定义背景时，可以通过该接口调整前景的位置坐标。
setPortraitSegmentationBackgroundBlurParam:param:
- (ZegoEffects)public setPortraitSegmentationBackgroundBlurParam:(ZegoEffectsBlurParam) param;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| param | ZegoEffectsBlurParam | 人像分割背景模糊功能参数。 |
详情
在使用背景模糊时，需要调用 [enablePortraitSegmentationBackgroundBlur] 启用背景模糊后该接口设置的背景才能生效。
setPortraitSegmentationBackgroundBuffer:buffer:mode:
- (ZegoEffects)public setPortraitSegmentationBackgroundBuffer:(CVPixelBufferRef) buffer mode:(ZegoEffectsScaleMode) mode;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| buffer | CVPixelBufferRef | 图片帧数据。 |
| mode | ZegoEffectsScaleMode | 显示的视图模式。 |
详情
在使用自定义背景时，需要调用 [enablePortraitSegmentationBackground] 启用自定义背景后该接口设置的背景才能生效。
setPortraitSegmentationBackgroundMosaicParam:param:
- (ZegoEffects)public setPortraitSegmentationBackgroundMosaicParam:(ZegoEffectsMosaicParam) param;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| param | ZegoEffectsMosaicParam | 马赛克参数。 |
详情
需要调用 [enablePortraitSegmentationBackgroundMosaic] 启用背景马赛克后该接口设置的背景才能生效。
setPortraitSegmentationBackgroundPath:imagePath:mode:
- (ZegoEffects)public setPortraitSegmentationBackgroundPath:(NSString *) imagePath mode:(ZegoEffectsScaleMode) mode;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| imagePath | NSString * | 图片路径。 |
| mode | ZegoEffectsScaleMode | 显示的视图模式。 |
详情
在使用自定义背景时，需要调用 [enablePortraitSegmentationBackground] 启用自定义背景后该接口设置的背景才能生效。
setPortraitSegmentationForegroundPosition:rect:
- (ZegoEffects)public setPortraitSegmentationForegroundPosition:(CGRect) rect;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| rect | CGRect | 前景的位置坐标。 |
详情
在人像分割使用自定义背景时，可以通过该接口调整前景的位置坐标。
enableFaceDetection:enable:
- (ZegoEffects)public enableFaceDetection:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动人脸检测功能；[true] 表示启动人脸检测功能；[false] 表示关闭去除人脸检测功能。默认值为 [false]。 |
详情
启动人脸检测后，开发者可通过 [ZegoEffectsEventHandler] 中的 [onFaceDetectionResult] 来获取人脸检测结果，包括人脸数量，人脸坐标等。
enableFaceLifting:enable:
- (ZegoEffects)public enableFaceLifting:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动瘦脸功能；[true] 表示启动瘦脸功能；[false] 表示关闭瘦脸功能。默认值为 [false]。 |
详情
开启后脸会变得更苗条，下巴更瘦。
enableNoseNarrowing:enable:
- (ZegoEffects)public enableNoseNarrowing:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动瘦鼻功能；[true] 表示启动瘦鼻功能；[false] 表示关闭瘦鼻功能。默认值为 [false]。 |
详情
开启瘦鼻功能，你可以调用 [setNoseNarrowingParam] 接口来设置参数。
enableSmallMouth:enable:
- (ZegoEffects)public enableSmallMouth:(BOOL) enable;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 是否启动长小嘴功能；[true] 表示启动长小嘴功能；[false] 表示关闭长小嘴功能。默认值为 [false]。 |
详情
开启长小嘴功能，可调用 [setSmallMouthParam] 接口设置参数。
processImageBuffer:buff:
- (void)processImageBuffer:(CVPixelBufferRef) buff;ZegoEffects.h参数
| 名称 | 类型 | 描述 |
|---|---|---|
| buff | CVPixelBufferRef | 视频帧的数据。 |
- 调用时机：在处理图像前请先调用 [initEnv] 初始化引擎环境，如果没有初始化引擎环境，会导致美颜失效。
- 注意事项：传入的 buff 需为 BGRA32 或 RGBA32格式。
ZegoEffectsAcneRemovingParam
开发者可通过该类调整祛痘斑参数。
详情
祛痘斑参数的系数值，通过系数值反映效果强度
- 业务场景：基础美颜效果之一
- 调用时机/通知时机：调用setAcneRemovingParam()函数的时候传递
- 相关回调：函数onError会吐回错误码，默认正常值是0。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：痘斑去除强度，默认值为 90,范围 [0~100]。
ZegoEffectsAdvancedConfig
引擎配置类
- 注意事项：必须在创建 effects 之前调用。
Declared in ZegoEffectsDefines.h
属性
advancedConfig
nonatomic, copy, nullable NSDictionary<NSString *, NSString *> * advancedConfig其他特殊功能开关，如渲染模式，设备性能等级等。如果不设置，默认不使用特殊功能。 使用前请联系ZEGO技术支持。
ZegoEffectsBigEyesParam
开发者可通过该类调整大眼属性。
详情
开发者可以通过该类修改大眼强度。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity大眼强度，取值范围 [0~100]。
ZegoEffectsBlurParam
开发者可通过该类调整模糊属性。
详情
开发者可以通过该类修改模糊强度。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity模糊强度，取值范围 [0~100]。
ZegoEffectsBlusherParam
开发者可通过该类调整腮红参数。
详情
开发者可通过该类调整腮红参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：腮红强度，范围 [0~100]。
ZegoEffectsCheekParam
腮红参数。
详情
开发者可通过该类修改腮红强度等参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity腮红强度，取值范围 [0~100]。
ZegoEffectsCheekboneSlimmingParam
开发者可通过该类调整瘦颧骨参数。
详情
开发者可通过该类调整瘦颧骨参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：瘦颧骨强度，范围 [0~100]。
ZegoEffectsChromaKeyParam
绿幕参数类。
详情
开发者可以按需设置绿幕参数。
Declared in ZegoEffectsDefines.h
属性
similarity
public float similarity更新颜色容差，容差越大，被替换的范围越大，范围 [0~100] ，默认 67。
smoothness
public float smoothness更新边缘平滑指数，越大越平滑，但渲染也会越慢，范围 [0~100] ，默认 80。
opacity
public int opacity更新透明度，范围 [0~100]，默认 100 (不透明)。
keyColor
public int keyColor更新要替换的颜色，格式：BGR，范围 [0,0xFFFFFF]，默认 0x00FF00。
borderSize
public int borderSize更新边缘像素采样半径，borderSize 越大边缘颜色过度越平缓，速度也越慢，背景和前景交接处的像素经常会有残留绿色，取附近像素平均值作为新的像素值，来去除残留，范围 [0~100]，默认 1。
ZegoEffectsClarityParam
开发者可通过该类清晰参数的系数值。
详情
通过系数值反映效果强度。
- 业务场景：基础美颜效果之一
- 调用时机/通知时机：调用setClarityParam()函数的时候传递。
- 相关回调：函数onError会吐回错误码，默认正常值是0。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：数值越大清晰度越大，默认值为0，范围 [0~100]。
ZegoEffectsColoredcontactsParam
开发者可通过该类调整美瞳参数。
详情
开发者可通过该类调整美瞳参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：美瞳强度，范围 [0~100]。
ZegoEffectsDarkCirclesRemovingParam
开发者可通过该类调整黑眼圈去除参数。
详情
开发者可通过该类调整黑眼圈去除参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：黑眼圈去除强度，范围 [0~100]。
ZegoEffectsEyelashesParam
开发者可通过该类调整眼睫毛参数。
详情
开发者可通过该类调整眼睫毛参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：眼睫毛强度，范围 [0~100]。
ZegoEffectsEyelinerParam
开发者可通过该类调整眼线参数。
详情
开发者可通过该类调整眼线参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：眼线强度，范围 [0~100]。
ZegoEffectsEyesBrighteningParam
亮眼参数。
详情
开发者可以通过该类设置亮眼强度等参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity亮眼强度，范围 [0~100]。
ZegoEffectsEyeshadowParam
开发者可通过该类调整眼影属性。
详情
开发者可通过该类调整眼影属性。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：眼影强度，范围 [0~100]。
ZegoEffectsFaceDetectionResult
人脸检测数据。
详情
人脸检测数据。
Declared in ZegoEffectsDefines.h
属性
score
public float score人脸的置信度, 越大表示更大概率是人脸。
rect
public CGRect rect人脸所在的矩形框, 完全包括了整个人脸, 单位是像素, 坐标系在输入图像的左上角。
ZegoEffectsFaceLiftingParam
开发者可通过该类调整瘦脸参数。
详情
开发者可通过该类调整瘦脸参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：瘦脸强度，范围 [-100~100]。
ZegoEffectsFaceShorteningParam
开发者可通过该类调整小脸参数。
详情
开发者可通过该类调整小脸参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：小脸强度，范围 [0~100]。
ZegoEffectsFilterParam
滤镜风格参数。
详情
滤镜风格参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：开发者可通过该属性调整滤镜强度。
ZegoEffectsForeheadShorteningParam
开发者可通过该类调整缩小额头高度参数。
详情
开发者可通过该类调整缩小额头高度参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity缩小额头高度强度，范围 [-100~100]。
ZegoEffectsLipstickParam
开发者可通过该类调整口红参数。
详情
开发者可通过该类调整口红参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：口红强度，范围 [0~100]。
ZegoEffectsLongChinParam
开发者可通过该类调整下巴参数。
详情
开发者可通过该类调整下巴参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity长下巴强度，范围 [-100~100]。
ZegoEffectsMakeupParam
开发者可通过该类调整风格妆参数。
详情
开发者可通过该类调整风格妆参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：风格妆强度，范围 [0~100]。
ZegoEffectsMandibleSlimmingParam
开发者可通过该类调整瘦下颌骨参数。
详情
开发者可通过该类调整瘦下颌骨参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：瘦下颌骨强度，范围 [0~100]。
ZegoEffectsMosaicParam
马赛克参数。
详情
马赛克参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity马赛克强度 [0~100]。
type
ZegoEffectsNoseLengtheningParam
长鼻强度，范围 [-100~100]。
详情
详情信息：长鼻强度，范围 [-100~100]。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：长鼻强度，范围 [-100~100]。
ZegoEffectsNoseNarrowingParam
开发者可以通过该类调整瘦鼻参数。
详情
开发者可以通过该类调整瘦鼻参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity瘦鼻强度，范围 [0-100]。
ZegoEffectsRosyParam
开发者可通过该类调整红润参数。
详情
开发者可通过该类调整红润参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：红润强度，范围 [0~100]。
ZegoEffectsSharpenParam
开发者可通过该类调整锐化参数。
详情
开发者可通过该类调整锐化参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：锐化强度，范围 [0~100]。
ZegoEffectsSkinColorParam
开发者可通过该类调整肤色参数。
详情
肤色参数的系数值，通过系数值反映效果强度
- 业务场景：基础美颜效果之一
- 调用时机/通知时机：先使用setSkinColorResPath()加载到皮肤资源，再调用setSkinColorParam()函数的时候传递该参数。
- 相关回调：函数onError会吐回错误码，默认正常值是0。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：肤色的变化强度值，默认值为 0,范围 [0~100]。
ZegoEffectsSmallMouthParam
开发者可通过该类调整小嘴参数。
详情
开发者可通过该类调整小嘴参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：小嘴强度，范围 [-100~100]。
ZegoEffectsSmoothParam
开发者可通过该类调整磨皮参数。
详情
开发者可通过该类调整磨皮参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：磨皮强度，范围 [0~100]。
ZegoEffectsTeethWhiteningParam
开发者可通过该类调整白牙参数。
详情
开发者可通过该类调整白牙参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：白牙强度，范围 [0~100]。
ZegoEffectsVideoFrameParam
视频帧详细参数。
详情
视频帧详细参数。
Declared in ZegoEffectsDefines.h
属性
width
public int width视频帧宽度，单位为像素。
height
public int height视频帧高度，单位为像素。
format
textureFormat
public ZegoEffectsTextureFormat textureFormat纹理格式，如果是传递纹理，可以指定对应纹理的格式，2D 纹理还是 OES 纹理（ Android 特有格式）。
ZegoEffectsWhitenParam
美白参数。
详情
开发者可以通过该类修改美白参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity美白强度，范围 [0~100]。
ZegoEffectsWrinklesRemovingParam
开发者可通过该类调整法令纹去除参数。
详情
开发者可通过该类调整法令纹去除参数。
Declared in ZegoEffectsDefines.h
属性
intensity
public int intensity详情信息：法令纹去除强度，范围 [-100~100]。