IFaceMakeupSettingContext Class Reference

face makeup setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IFaceMakeupSettingContextEvent *pEvent)=0
	face makeup callback handler.
virtual bool	IsFaceMakeupEnabled ()=0
	Determine if the face makeup feature is enabled.
virtual bool	IsSupportFaceMakeup ()=0
	Determine if the meeting supports the the face makeup feature.
virtual SDKError	EnableFaceMakeupEffectForAllMeeting (bool bEnable)=0
	Enable/Disable the selected face makeup effect always used by the future meeting.
virtual bool	IsFaceMakeupEffectForAllMeetingEnabled ()=0
	Determine if the selected face makeup effect is always used by future meetings.
virtual IList< IFaceMakeupImageInfo * > *	GetFaceMakeupImageList ()=0
	Get the list of the face makeup images.
virtual SDKError	SetFaceMakeupImage (IFaceMakeupImageInfo *pImage)=0
	Specify an image to be face makeup image.
virtual SDKError	SetLipsFaceMakeup (bool bEnable)=0
	Enable/Disable the lip face makeup effect.
virtual SDKError	SetColor (ZoomSDKFaceMakeupType type, unsigned long color)=0
	Set the colors of face makeup effect.
virtual SDKError	SetOpactity (ZoomSDKFaceMakeupType type, unsigned int opactity)=0
	Set the transparency of face makeup effect.
virtual SDKError	ResetAllFaceMakeupEffect ()=0
	Disable all the face makeup effect and reset color/opactity value to default value.
virtual ITestVideoDeviceHelper *	GetTestVideoDeviceHelper ()=0
	Get the pointer to ITestVideoDeviceHelper which is used to preview the video with face makeup image.

Detailed Description

face makeup setting interface.

Definition at line 2699 of file setting_service_interface.h.

Member Function Documentation

EnableFaceMakeupEffectForAllMeeting()

virtual SDKError IFaceMakeupSettingContext::EnableFaceMakeupEffectForAllMeeting ( bool bEnable )

pure virtual

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

Parameters

bEnable

true means enabled. FALSE not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

GetFaceMakeupImageList()

virtual IList< IFaceMakeupImageInfo * > * IFaceMakeupSettingContext::GetFaceMakeupImageList ( )

pure virtual

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 IFaceMakeupImageInfo. Otherwise returns nullptr. To get extended information, see IFaceMakeupImageInfo enum.

GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper * IFaceMakeupSettingContext::GetTestVideoDeviceHelper ( )

pure virtual

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

Returns

If the function succeeds, the return value is the pointer to ITestVideoDeviceHelper. Otherwise returns nullptr. For more details, see ITestVideoDeviceHelper.

IsFaceMakeupEffectForAllMeetingEnabled()

virtual bool IFaceMakeupSettingContext::IsFaceMakeupEffectForAllMeetingEnabled ( )

pure virtual

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

Returns

true means that the selected face makeup effect still applies to future meetings.

IsFaceMakeupEnabled()

virtual bool IFaceMakeupSettingContext::IsFaceMakeupEnabled ( )

pure virtual

Determine if the face makeup feature is enabled.

Returns

true meas that the face makeup feature is enabled.

IsSupportFaceMakeup()

virtual bool IFaceMakeupSettingContext::IsSupportFaceMakeup ( )

pure virtual

Determine if the meeting supports the the face makeup feature.

Returns

true meas that the meeting supports the face makeup feature.

ResetAllFaceMakeupEffect()

virtual SDKError IFaceMakeupSettingContext::ResetAllFaceMakeupEffect ( )

pure virtual

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

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

SetColor()

virtual SDKError IFaceMakeupSettingContext::SetColor ( ZoomSDKFaceMakeupType type, unsigned long color )

pure virtual

Set the colors of face makeup effect.

Parameters

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

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

SetEvent()

virtual SDKError IFaceMakeupSettingContext::SetEvent ( IFaceMakeupSettingContextEvent * pEvent )

pure virtual

face makeup callback handler.

Parameters

pEvent

A pointer to the IFaceMakeupSettingContextEvent that receives face makeup event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call the function before using any other interface of the same class.

SetFaceMakeupImage()

virtual SDKError IFaceMakeupSettingContext::SetFaceMakeupImage ( IFaceMakeupImageInfo * pImage )

pure virtual

Specify an image to be face makeup image.

Parameters

pImage

Specify the image to use. To get extended information, see IFaceMakeupImageInfo enum.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed and returns an error. For detailed error codes, see the SDKError enum.

SetLipsFaceMakeup()

virtual SDKError IFaceMakeupSettingContext::SetLipsFaceMakeup ( bool bEnable )

pure virtual

Enable/Disable the lip face makeup effect.

Parameters

bEnable

true means enabled. FALSE not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

SetOpactity()

virtual SDKError IFaceMakeupSettingContext::SetOpactity ( ZoomSDKFaceMakeupType type, unsigned int opactity )

pure virtual

Set the transparency of face makeup effect.

Parameters

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

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.