ZoomSDKFaceMakeupSettingContext Class Reference

Provides APIs to manage face makeup settings in Zoom SDK. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

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

Protected Attributes
id< ZoomSDKFaceMakeupSettingContextDelegate >	_delegate

Properties
id< ZoomSDKFaceMakeupSettingContextDelegate >	delegate
	The delegate to receive face makeup setting events.

Detailed Description

Provides APIs to manage face makeup settings in Zoom SDK.

Definition at line 2120 of file ZoomSDKSettingService.h.

Method Documentation

enableFaceMakeupEffectForAllMeeting:

- (ZoomSDKError) enableFaceMakeupEffectForAllMeeting:

(BOOL)

enable

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

Parameters

enable

YES indicates enabled, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

getFaceMakeupImageList

- (NSArray< ZoomSDKFaceMakeupImageInfo * > *_Nullable) getFaceMakeupImageList

Gets the list of face makeup images.

Returns

If there are images in the list, the pointers's return value is a list to ZoomSDKFaceMakeupImageInfo. Otherwise, this function fails and returns nil.

References getFaceMakeupImageList.

Referenced by getFaceMakeupImageList.

getTestVideoDeviceHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getTestVideoDeviceHelper

Gets the pointer to ZoomSDKSettingTestVideoDeviceHelper for previewing the video with face makeup image.

Returns

If the function succeeds, it returns the pointer to ZoomSDKSettingTestVideoDeviceHelper. Otherwise, this function fails and returns nil.

References getTestVideoDeviceHelper.

Referenced by getTestVideoDeviceHelper.

isFaceMakeupEffectForAllMeetingEnabled

- (BOOL) isFaceMakeupEffectForAllMeetingEnabled

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

Returns

YES if the selected face makeup effect still applies to future meetings. Otherwise, NO.

References isFaceMakeupEffectForAllMeetingEnabled.

Referenced by isFaceMakeupEffectForAllMeetingEnabled.

isFaceMakeupEnabled

- (BOOL) isFaceMakeupEnabled

Determines if the face makeup feature is enabled.

Returns

YES if face makeup feature is enabled. Otherwise, NO.

References isFaceMakeupEnabled.

Referenced by isFaceMakeupEnabled.

isSupportFaceMakeup

- (BOOL) isSupportFaceMakeup

Determines if the meeting supports the face makeup feature.

Returns

YES if the meeting supports the face makeup feature. Otherwise, NO.

References isSupportFaceMakeup.

Referenced by isSupportFaceMakeup.

resetAllFaceMakeupEffect

- (ZoomSDKError) resetAllFaceMakeupEffect

Disables all the face makeup effect and reset color or opactity value to default value.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

References resetAllFaceMakeupEffect.

Referenced by resetAllFaceMakeupEffect.

setColor:type:

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

Sets the colors of face makeup effect.

Parameters

color	Specify the face makeup effect's color in RGB format.
type	The specified color uses on which face makeup type.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setFaceMakeupImage:

- (ZoomSDKError) setFaceMakeupImage:

(ZoomSDKFaceMakeupImageInfo *)

image

Specify an image to be face makeup image.

Parameters

image

Specify the image to use.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setLipsFaceMakeup:

- (ZoomSDKError) setLipsFaceMakeup:

(BOOL)

enable

Enable or Disable the lip face makeup effect.

Parameters

enable

YES indicates enabled, NO otherwise.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

setOpacity:type:

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

Sets the transparency of face makeup effect.

Parameters

opactity	Specify the face makeup effect's transparency. The value should be between 0 to 100.
type	The specified color uses on which face makeup type.

Returns

If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKFaceMakeupSettingContextDelegate>) _delegate

protected

Definition at line 2122 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKFaceMakeupSettingContextDelegate>) delegate

readwritenonatomicassign

The delegate to receive face makeup setting events.

Definition at line 2128 of file ZoomSDKSettingService.h.