ZoomSDKFaceMakeupSettingContext Class Reference

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isFaceMakeupEnabled
	Determine if the face makeup feature is enabled.
(BOOL)	- isSupportFaceMakeup
	Determine if the meeting supports the face makeup feature.
(ZoomSDKError)	- enableFaceMakeupEffectForAllMeeting:
	Enable/Disable the selected face makeup effect is always used by future meetings.
(BOOL)	- isFaceMakeupEffectForAllMeetingEnabled
	Determine if the selected face makeup effect is always used by future meetings.
(NSArray< ZoomSDKFaceMakeupImageInfo * > *_Nullable)	- getFaceMakeupImageList
	Get the list of the face makeup images.
(ZoomSDKError)	- setFaceMakeupImage:
	Specify an image to be face makeup image.
(ZoomSDKError)	- setLipsFaceMakeup:
	Enable/Disable the lip face makeup effect.
(ZoomSDKError)	- setColor:type:
	Set the colors of face makeup effect.
(ZoomSDKError)	- setOpacity:type:
	Set the transparency of face makeup effect.
(ZoomSDKError)	- resetAllFaceMakeupEffect
	Disable all the face makeup effect and reset color/opactity value to default value.
(ZoomSDKSettingTestVideoDeviceHelper *_Nullable)	- getTestVideoDeviceHelper
	Get the pointer to ZoomSDKSettingTestVideoDeviceHelper which is used to preview the video with face makeup image.

Protected Attributes
id< ZoomSDKFaceMakeupSettingContextDelegate >	_delegate

Properties
id< ZoomSDKFaceMakeupSettingContextDelegate >	delegate

Detailed Description

Definition at line 1905 of file ZoomSDKSettingService.h.

Method Documentation

enableFaceMakeupEffectForAllMeeting:

- (ZoomSDKError) enableFaceMakeupEffectForAllMeeting:

(BOOL)

enable

Enable/Disable the selected face makeup effect is always used by future meetings.

Parameters

enable

YES indicates enabled. Otherwise not.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

getFaceMakeupImageList

- (NSArray< ZoomSDKFaceMakeupImageInfo * > *_Nullable) getFaceMakeupImageList

Get the list of the face makeup images.

Returns

If there are images in the list, the return value is a list of the pointers to ZoomSDKFaceMakeupImageInfo.

getTestVideoDeviceHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getTestVideoDeviceHelper

Get the pointer to ZoomSDKSettingTestVideoDeviceHelper which is used to preview the video with face makeup image.

Returns

If the function succeeds, the return value is the pointer to ZoomSDKSettingTestVideoDeviceHelper.

isFaceMakeupEffectForAllMeetingEnabled

- (BOOL) isFaceMakeupEffectForAllMeetingEnabled

Determine if the selected face makeup effect is always used by future meetings.

Returns

YES indicates that the selected face makeup effect still applies to future meetings.

isFaceMakeupEnabled

- (BOOL) isFaceMakeupEnabled

Determine if the face makeup feature is enabled.

Returns

YES indicates that face makeup feature is enabled.

isSupportFaceMakeup

- (BOOL) isSupportFaceMakeup

Determine if the meeting supports the face makeup feature.

Returns

YES indicates that the meeting supports the face makeup feature.

resetAllFaceMakeupEffect

- (ZoomSDKError) resetAllFaceMakeupEffect

Disable all the face makeup effect and reset color/opactity value to default value.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setColor:type:

- (ZoomSDKError) setColor:		(NSColor *)	color
type:		(ZoomSDKFaceMakeupType)	type

Set the colors of face makeup effect.

Parameters

color	Specify the color of the face makeup effect in RGB format.
type	The specified color is used on which face makeup type. For more details, see ZoomSDKFaceMakeupType.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setFaceMakeupImage:

- (ZoomSDKError) setFaceMakeupImage:

(ZoomSDKFaceMakeupImageInfo *)

image

Specify an image to be face makeup image.

Parameters

image

Specify the image to use. To get extended information,refer to {@ink ZoomSDKFaceMakeupImageInfo}.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setLipsFaceMakeup:

- (ZoomSDKError) setLipsFaceMakeup:

(BOOL)

enable

Enable/Disable the lip face makeup effect.

Parameters

enable

YES indicates enabled. Otherwise not.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

setOpacity:type:

- (ZoomSDKError) setOpacity:		(int)	opacity
type:		(ZoomSDKFaceMakeupType)	type

Set the transparency of face makeup effect.

Parameters

opactity	Specify the transparency of the face makeup effect. The value should be between 0 to 100.
type	The specified color is used on which face makeup type. For more details, see ZoomSDKFaceMakeupType.

Returns

If the function is success will return ZoomSDKError_Success, otherwise fail.

Field Documentation

_delegate

- (id<ZoomSDKFaceMakeupSettingContextDelegate>) _delegate

protected

Definition at line 1907 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKFaceMakeupSettingContextDelegate>) delegate

readwritenonatomicassign

Definition at line 1909 of file ZoomSDKSettingService.h.