#import <NERtcBeauty.h>

类 NERtcBeauty 继承关系图:

构造函数
(int)	- startBeauty
	开启美颜功能模块。更多...

(void)	- stopBeauty
	结束美颜功能模块。通过此接口实现关闭美颜功能模块后，SDK 会自动销毁美颜引擎并释放资源。更多...

(void)	- setBeautyEffectWithValue:atType:
	设置美颜效果。通过此接口可以实现设置磨皮、美白、大眼等多种全局美颜类型和对应的美颜强度。更多...

(int)	- addTempleteWithPath:andName:
	导入美颜资源或模型。更多...

(void)	- addBeautyFilterWithPath:andName:
	添加滤镜效果。通过此接口可以实现加载滤镜资源，并添加对应的滤镜效果；若您需要更换滤镜，重复调用此接口使用新的滤镜资源即可。更多...

(void)	- removeBeautyFilter
	取消滤镜效果。更多...

(void)	- addBeautyStickerWithPath:andName:
	（此接口为 beta 版本）添加贴纸效果。此接口用于加载贴纸资源，添加对应的贴纸效果。需要更换贴纸时，重复调用此接口使用新的贴纸资源即可。更多...

(void)	- removeBeautySticker
	（此接口为 beta 版本）取消贴纸效果。更多...

(void)	- addBeautyMakeupWithPath:andName:
	（此接口为 beta 版本）添加美妆效果。此接口用于加载美妆模型，添加对应的贴纸效果。需要更换美妆效果时，重复调用此接口使用新的美妆模型即可。更多...

(void)	- removeBeautyMakeup
	（此接口为 beta 版本）取消美妆效果。更多...

(NSString *)	- getError
	获取美颜相关的错误信息。更多...

类方法
(NERtcBeauty *)	+ shareInstance

属性
float	teeth
	美牙取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	brightEye
	亮眼取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	whiteSkin
	美白取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	smoothSkin
	磨皮取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	smallNose
	小鼻取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

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

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

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

float	bigEye
	大眼取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	smallFace
	小脸取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	jaw
	下巴调整取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	thinFace
	瘦脸取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	faceRuddyStrength
	红润取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	longNoseStrength
	长鼻取值范围:[0.0, 1.0] 0.5为无效果，0.0和1.0最大效果，默认值0.5 更多...

float	renZhongStrength
	人中取值范围:[0.0, 1.0] 0.5为无效果，0.0和1.0最大效果，默认值0.5 更多...

float	mouthAngle
	嘴角取值范围:[0.0, 1.0] 0.5为无效果，0.0和1.0最大效果，默认值0.5 更多...

float	roundEyeStrength
	圆眼取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	openEyeAngleStrength
	开眼角取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	vFaceStrength
	V脸取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	thinUnderjawStrength
	瘦下颌取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	narrowFaceStrength
	窄脸取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	cheekBoneStrength
	瘦颧骨取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	faceSharpenStrength
	锐化取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

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

float	foreheadWrinklesStrength
	祛抬头纹取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	darkCirclesStrength
	祛黑眼圈取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	smileLinesStrength
	祛法令纹取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

float	shortFaceStrength
	短脸取值范围:[0.0, 1.0] 0.0为无效果，1.0为最大效果，默认值0.0 更多...

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

BOOL	flipX
	启用美颜时，启用或关闭镜像模式。默认为 NO，表示美颜时启用镜像模式。更多...

BOOL	isLandscape
	启用美颜时，设置采集图像是否横屏。默认为 NO，表示美颜时处理竖屏图像。更多...

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

函数文档

◆ addBeautyFilterWithPath:andName:

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

添加滤镜效果。
通过此接口可以实现加载滤镜资源，并添加对应的滤镜效果；若您需要更换滤镜，重复调用此接口使用新的滤镜资源即可。

自从: V4.6.10

使用前提: 请先调用 NERtcBeauty#startBeauty 方法开启美颜功能模块。

调用时机: 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

注解

使用滤镜、贴纸和美妆等自定义美颜效果之前，请联系商务经理获取美颜资源或模型。
滤镜效果可以和全局美颜、贴纸、美妆等效果互相叠加，但是不支持叠加多个滤镜。

参数说明

参数名称	类型	描述
path	NSString *	滤镜资源或模型所在路径，应指定为绝对路径。
name	NSString *	滤镜资源或模型文件的名称。

示例代码: [[NERtcBeauty shareInstance] addBeautyFilterWithPath:resourcePath andName:@"template.json"];

NERtcBeauty
Definition: NERtcBeauty.h:290

+[NERtcBeauty shareInstance]
NERtcBeauty * shareInstance()

返回: 无返回值。

◆ addBeautyMakeupWithPath:andName:

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

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

注解

使用滤镜、贴纸和美妆等自定义美颜效果之前，需要先通过方法 NERtcBeauty#startBeauty 开启美颜模块。
美妆效果可以和全局美颜、滤镜、贴纸等效果互相叠加，但是不支持叠加多个美妆效果。

自从: V4.2.202

参数

path	美妆资源或模型所在的路径。应指定为绝对路径。
name	美妆资源或模型文件的名称。

返回

0：方法调用成功。
其他：方法调用失败。

◆ addBeautyStickerWithPath:andName:

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

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

注解

使用滤镜、贴纸和美妆等自定义美颜效果之前，需要先通过方法 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

取消滤镜效果。

自从: V4.2.202

返回

0：方法调用成功。
其他：方法调用失败。

◆ removeBeautyMakeup

- (void) removeBeautyMakeup

（此接口为 beta 版本）取消美妆效果。

自从: V4.2.202

返回

0：方法调用成功。
其他：方法调用失败。

◆ removeBeautySticker

- (void) removeBeautySticker

（此接口为 beta 版本）取消贴纸效果。

自从: V4.2.202

返回

0：方法调用成功。
其他：方法调用失败。

◆ setBeautyEffectWithValue:atType:

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

设置美颜效果。通过此接口可以实现设置磨皮、美白、大眼等多种全局美颜类型和对应的美颜强度。

自从: V4.6.10

使用前提: 请先调用 NERtcBeauty#startBeauty 方法开启美颜。

调用时机: 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

注解: 您可以多次调用此接口以叠加多种全局美颜效果，也可以在此基础上通过其他方法叠加滤镜等自定义效果。

参数说明

参数名称	类型	描述
type	NERtcBeautyEffectType	美颜类型。
value	float	对应美颜类型的强度。取值范围为 [0, 1]，各种美颜效果的默认值不同。

示例代码: NERtcBeautyEffectType type = kNERtcBeautyWhiten;

float value = 0.5;

[[NERtcBeauty shareInstance] setBeautyEffectWithValue:value atType:type];

NERtcBeautyEffectType
NERtcBeautyEffectType
美颜类型。
Definition: NERtcBeauty.h:12

kNERtcBeautyWhiten
@ kNERtcBeautyWhiten
美白。强度默认值为 0.0。
Definition: NERtcBeauty.h:41

相关接口: 可以调用 NERtcBeauty#addBeautyFilterWithPath:andName: 方法叠加滤镜等自定义美颜效果。

返回

0（kNERtcNoError）：方法调用成功。
其他：方法调用失败。
- 30005（kNERtcErrInvalidState）：当前状态不支持的操作，比如引擎尚未初始化。

◆ shareInstance

+ (NERtcBeauty *) shareInstance

◆ startBeauty

- (int) startBeauty

开启美颜功能模块。

自从: V4.6.10

使用前提: 请先调用 INERtcEngine#enableLocalVideo:streamType: 方法开启本地视频采集。

调用时机: 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

注解: 开启美颜功能模块后，默认无美颜效果，您需要通过 NERtcBeauty#setBeautyEffectWithValue:atType: 或其他滤镜等相关接口设置美颜或滤镜效果。

示例代码: [[NERtcBeauty shareInstance] startBeauty];

-[NERtcBeauty startBeauty]
int startBeauty()
开启美颜功能模块。

相关接口

NERtcBeauty#setBeautyEffectWithValue:atType:：设置美颜效果。
NERtcBeauty#addBeautyFilterWithPath:andName:：添加滤镜效果。
NERtcBeauty#stopBeauty：结束美颜功能模块，销毁美颜引擎并释放资源。

返回

0（kNERtcNoError）：方法调用成功；
其他：方法调用失败。
- 30001（kNERtcErrFatal）：状态错误，比如引擎尚未初始化。
- 30004（kNERtcErrNotSupported）：纯音频 SDK 不支持该功能。
- 30005（kNERtcErrInvalidState）：当前状态不支持的操作，比如引擎尚未初始化。

◆ stopBeauty

- (void) stopBeauty

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

自从: V4.6.10

调用时机: 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。

示例代码: [[NERtcBeauty shareInstance] stopBeauty];

-[NERtcBeauty stopBeauty]
void stopBeauty()
结束美颜功能模块。通过此接口实现关闭美颜功能模块后，SDK 会自动销毁美颜引擎并释放资源。

返回: 无返回值。

属性说明

◆ 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

◆ isLandscape

- (BOOL) isLandscape

readwritenonatomicassign

启用美颜时，设置采集图像是否横屏。默认为 NO，表示美颜时处理竖屏图像。

美颜功能启用时，此接口用于设置采集图像是否横屏。默认为关闭状态。美颜功能暂停或结束后，此接口不再生效。
设置图像横屏后，表示会按照横屏方向对图像进行处理。
该参数已废弃。

◆ isOpenBeauty

- (BOOL) isOpenBeauty

readwritenonatomicassign

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

注解: 美颜效果默认开启。若您需要临时关闭美颜功能，需要在 startBeauty 之后调用该方法。

自从: V4.2.202

参数

enable

是否恢复美颜效果。

YES（默认）：恢复美颜效果。
NO：暂停美颜效果。

返回

0：方法调用成功。
其他：方法调用失败。

◆ 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

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

exportHeaders/NERtcBeauty.h

构造函数

类方法

属性

函数文档

◆ addBeautyFilterWithPath:andName:

◆ addBeautyMakeupWithPath:andName:

◆ addBeautyStickerWithPath:andName:

◆ addTempleteWithPath:andName:

◆ getError

◆ removeBeautyFilter

◆ removeBeautyMakeup

◆ removeBeautySticker

◆ setBeautyEffectWithValue:atType:

◆ shareInstance

◆ startBeauty

◆ stopBeauty

属性说明

◆ bigEye

◆ brightEye

◆ cheekBoneStrength

◆ darkCirclesStrength

◆ eyesAngle

◆ eyesDistance

◆ faceRuddyStrength

◆ faceSharpenStrength

◆ filterStrength

◆ flipX

◆ foreheadWrinklesStrength

◆ isLandscape

◆ isOpenBeauty

◆ jaw

◆ longNoseStrength

◆ mouth

◆ mouthAngle

◆ mouthWiderStrength

◆ narrowFaceStrength

◆ openEyeAngleStrength

◆ renZhongStrength

◆ roundEyeStrength

◆ shortFaceStrength

◆ smallFace

◆ smallNose

◆ smileLinesStrength

◆ smoothSkin

◆ teeth

◆ thinFace

◆ thinUnderjawStrength

◆ vFaceStrength

◆ whiteSkin