NERtc Windows SDK V5.6.20
载入中...
搜索中...
未找到
构造函数 | 类方法 | 属性 | 所有成员列表
NERtcBeauty类 参考
类 NERtcBeauty 继承关系图:

构造函数

(int) - startBeauty
 
(void) - stopBeauty
 
(void) - setBeautyEffectWithValue:atType:
 
(int) - addTempleteWithPath:andName:
 
(void) - addBeautyFilterWithPath:andName:
 
(void) - removeBeautyFilter
 
(void) - addBeautyStickerWithPath:andName:
 
(void) - removeBeautySticker
 
(void) - addBeautyMakeupWithPath:andName:
 
(void) - removeBeautyMakeup
 
(NSString *) - getError
 

类方法

(NERtcBeauty *) + shareInstance
 

属性

float teeth
 
float brightEye
 
float whiteSkin
 
float smoothSkin
 
float smallNose
 
float eyesDistance
 
float eyesAngle
 
float mouth
 
float bigEye
 
float smallFace
 
float jaw
 
float thinFace
 
float faceRuddyStrength
 
float longNoseStrength
 
float renZhongStrength
 
float mouthAngle
 
float roundEyeStrength
 
float openEyeAngleStrength
 
float vFaceStrength
 
float thinUnderjawStrength
 
float narrowFaceStrength
 
float cheekBoneStrength
 
float faceSharpenStrength
 
float mouthWiderStrength
 
float foreheadWrinklesStrength
 
float darkCirclesStrength
 
float smileLinesStrength
 
float shortFaceStrength
 
float filterStrength
 
BOOL flipX
 
BOOL isOpenBeauty
 

函数文档

◆ addBeautyFilterWithPath:andName:

- (void) addBeautyFilterWithPath: (NSString *) path
andName: (NSString *) name 

添加滤镜效果。
此接口用于加载滤镜资源,并添加对应的滤镜效果。需要更换滤镜时,重复调用此接口使用新的滤镜资源即可。

注解
  • 该方法仅适用于 macOS 平台。
  • 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先通过方法 NERtcBeauty#startBeauty 开启美颜模块。
  • 滤镜效果可以和全局美颜、贴纸、美妆等效果互相叠加,但是不支持叠加多个滤镜。
自从
V4.2.202
参数
path滤镜资源或模型所在的路径。应指定为绝对路径。
name滤镜资源或模型文件的名称。
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ addBeautyMakeupWithPath:andName:

- (void) addBeautyMakeupWithPath: (NSString *) path
andName: (NSString *) name 

(此接口为 beta 版本)添加美妆效果。
此接口用于加载美妆模型,添加对应的贴纸效果。需要更换美妆效果时,重复调用此接口使用新的美妆模型即可。

注解
  • 该方法仅适用于 macOS 平台。
  • 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先通过方法 NERtcBeauty#startBeauty 开启美颜模块。
  • 美妆效果可以和全局美颜、滤镜、贴纸等效果互相叠加,但是不支持叠加多个美妆效果。
自从
V4.2.202
参数
path美妆资源或模型所在的路径。应指定为绝对路径。
name美妆资源或模型文件的名称。
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ addBeautyStickerWithPath:andName:

- (void) addBeautyStickerWithPath: (NSString *) path
andName: (NSString *) name 

(此接口为 beta 版本)添加贴纸效果。
此接口用于加载贴纸资源,添加对应的贴纸效果。需要更换贴纸时,重复调用此接口使用新的贴纸资源即可。

注解
  • 该方法仅适用于 macOS 平台。
  • 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先通过方法 NERtcBeauty#startBeauty 开启美颜模块。
  • 贴纸效果可以和全局美颜、滤镜、美妆等效果互相叠加,但是不支持叠加多个贴纸。
自从
V4.2.202
参数
path贴纸资源或模型所在的路径。应指定为绝对路径。
name贴纸资源或模型文件的名称。
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ addTempleteWithPath:andName:

- (int) addTempleteWithPath: (NSString *) path
andName: (NSString *) name 

导入美颜资源或模型。

注解
  • 使用滤镜、贴纸和美妆等自定义美颜效果之前,需要先通过此方法导入美颜资源或模型。
  • 美颜功能模块开启过程中,如果资源路径或名称没有变更,则只需导入一次。如需更换资源,需要调用此接口重新导入。
  • 该接口已废弃,不再需要调用。
自从
V4.2.202
参数
path美颜资源或模型所在的路径。应指定为绝对路径。
name美颜资源或模型文件的名称。
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ getError

- (NSString *) getError

获取美颜相关的错误信息。

自从
V4.2.202
返回
错误码。
  • 0:调用成功。
  • 1:权限不足。请联系网易云信商务经理了解计费策略,并开通美颜功能。
  • 100:引擎内部错误。请 提交工单 联系网易云信技术支持工程师排查。

◆ removeBeautyFilter

- (void) removeBeautyFilter

取消滤镜效果。

注解
该方法仅适用于 macOS 平台。
自从
V4.2.202
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ removeBeautyMakeup

- (void) removeBeautyMakeup

(此接口为 beta 版本)取消美妆效果。

注解
该方法仅适用于 macOS 平台。
自从
V4.2.202
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ removeBeautySticker

- (void) removeBeautySticker

(此接口为 beta 版本)取消贴纸效果。

注解
该方法仅适用于 macOS 平台。
自从
V4.2.202
返回
  • 0:方法调用成功。
  • 其他:方法调用失败。

◆ setBeautyEffectWithValue:atType:

- (void) setBeautyEffectWithValue: (float) value
atType: (int) type 

设置美颜类型和强度。

  • 此方法可用于设置磨皮、美白、大眼等多种全局美颜类型。
  • 多次调用此接口可以叠加多种全局美颜效果,也可以通过相关方法叠加滤镜、贴纸、美妆等自定义效果。
    注解
    该方法仅适用于 macOS 平台。
    自从
    V4.2.202
    参数
    type美颜类型。详细信息请参考 NERtcBeautyEffectType
    value对应美颜类型的强度。取值范围为 [0, 1],各种美颜效果的默认值不同。
    返回
    • 0:方法调用成功。
    • 其他:方法调用失败。

◆ startBeauty

- (int) startBeauty

开启美颜功能模块。

  • 调用此接口后,开启美颜引擎。如果后续不再需要使用美颜功能,可以调用 stopBeauty 结束美颜功能模块,销毁美颜引擎并释放资源。
  • 开启美颜功能模块后,默认无美颜效果,您需要通过 NERtcBeauty#setBeautyEffectWithValue:atType: 或其他滤镜、贴纸相关接口设置美颜或滤镜效果。
    注解
  • 该方法仅适用于 macOS 平台。
    自从
    V4.2.202
    返回
  • 0: 方法调用成功。
  • 30001(kNERtcErrFatal):方法调用失败。
  • 30004(kNERtcErrNotSupported):不支持美颜功能。

◆ stopBeauty

- (void) stopBeauty

结束美颜功能模块。
通过此接口实现关闭美颜功能模块后,SDK 会自动销毁美颜引擎并释放资源。

自从
V4.6.10
调用时机
请在引擎初始化之后调用此接口,且该方法在加入房间前后均可调用。
注解
该方法仅适用于 macOS 平台。
示例代码
rtc_engine_->stopBeauty();
返回
无返回值。

属性说明

◆ bigEye

- (float) bigEye
readwritenonatomicassign

大眼 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ brightEye

- (float) brightEye
readwritenonatomicassign

亮眼 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ cheekBoneStrength

- (float) cheekBoneStrength
readwritenonatomicassign

瘦颧骨 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ darkCirclesStrength

- (float) darkCirclesStrength
readwritenonatomicassign

祛黑眼圈 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ eyesAngle

- (float) eyesAngle
readwritenonatomicassign

眼角调整 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ eyesDistance

- (float) eyesDistance
readwritenonatomicassign

眼距调整 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ faceRuddyStrength

- (float) faceRuddyStrength
readwritenonatomicassign

红润 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ faceSharpenStrength

- (float) faceSharpenStrength
readwritenonatomicassign

锐化 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ filterStrength

- (float) filterStrength
readwritenonatomicassign

设置滤镜强度。 取值范围为 [0 - 1],默认值为 0.0。取值越大,滤镜强度越大,开发者可以根据业务需求自定义设置滤镜强度。 滤镜强度设置实时生效,更换滤镜后滤镜强度不变,如需调整,可以再次通过此参数设置滤镜强度。

◆ flipX

- (BOOL) flipX
readwritenonatomicassign

启用美颜时,启用或关闭镜像模式。 默认为 NO,表示美颜时启用镜像模式。

  • 美颜功能启用时,此接口用于开启或关闭镜像模式。默认为关闭状态。美颜功能暂停或结束后,此接口不再生效。
  • 启用镜像模式之后,本端画面会呈现为左右翻转的视觉效果。
  • 该参数已废弃。

◆ foreheadWrinklesStrength

- (float) foreheadWrinklesStrength
readwritenonatomicassign

祛抬头纹 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ isOpenBeauty

- (BOOL) isOpenBeauty
readwritenonatomicassign

暂停或恢复美颜效果。
暂停美颜效果后,包括全局美颜、滤镜、贴纸和美妆在内的所有美颜效果都会暂时关闭,直至重新恢复美颜效果。

注解
  • 该方法仅适用于 macOS 平台。
  • 美颜效果默认开启。若您需要临时关闭美颜功能,需要在 startBeauty 之后调用该方法。
自从
V4.2.202
参数
enable是否恢复美颜效果。
  • YES(默认):恢复美颜效果。
  • NO:暂停美颜效果。

◆ jaw

- (float) jaw
readwritenonatomicassign

下巴调整 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ longNoseStrength

- (float) longNoseStrength
readwritenonatomicassign

长鼻 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ mouth

- (float) mouth
readwritenonatomicassign

嘴型调整 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ mouthAngle

- (float) mouthAngle
readwritenonatomicassign

嘴角 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ mouthWiderStrength

- (float) mouthWiderStrength
readwritenonatomicassign

调整嘴巴宽度 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ narrowFaceStrength

- (float) narrowFaceStrength
readwritenonatomicassign

窄脸 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ openEyeAngleStrength

- (float) openEyeAngleStrength
readwritenonatomicassign

开眼角 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ renZhongStrength

- (float) renZhongStrength
readwritenonatomicassign

人中 取值范围:[0.0, 1.0] 0.5 为无效果,0.0 和 1.0 最大效果,默认值 0.5

◆ roundEyeStrength

- (float) roundEyeStrength
readwritenonatomicassign

圆眼 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ shortFaceStrength

- (float) shortFaceStrength
readwritenonatomicassign

短脸 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ smallFace

- (float) smallFace
readwritenonatomicassign

小脸 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ smallNose

- (float) smallNose
readwritenonatomicassign

小鼻 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ smileLinesStrength

- (float) smileLinesStrength
readwritenonatomicassign

祛法令纹 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ smoothSkin

- (float) smoothSkin
readwritenonatomicassign

磨皮 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ teeth

- (float) teeth
readwritenonatomicassign

美牙 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ thinFace

- (float) thinFace
readwritenonatomicassign

瘦脸 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ thinUnderjawStrength

- (float) thinUnderjawStrength
readwritenonatomicassign

瘦下颌 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ vFaceStrength

- (float) vFaceStrength
readwritenonatomicassign

V 脸 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0

◆ whiteSkin

- (float) whiteSkin
readwritenonatomicassign

美白 取值范围:[0.0, 1.0] 0.0 为无效果,1.0 为最大效果,默认值 0.0


该类的文档由以下文件生成: