Configure Service Interface. More...

#include "zoom_sdk_def.h"
#include "zoom_sdk_util_define.h"

Data Structures
class	ICameraInfo
	Camera device information interface. More...

class	IMicInfo
	Microphone device information interface. More...

class	ISpeakerInfo
	Audio speaker device information interface. More...

class	IRingSpeakerInfo
	Ring speaker device information interface. More...

struct	tagShowSettingDlgParam
	The parameter to show the meeting setting dialog in Zoom UI. More...

struct	tagSettingDlgShowTabPageOption
	Define the strategy to show the tab pages in the setting dialog. More...

struct	tagSettingDlgShowUrlOption
	Define the strategy to show the url in the setting dialog. More...

class	ITestAudioDeviceHelperEvent
	Audio device testing callback events. More...

class	ITestAudioDeviceHelper
	Audio device test interface. More...

class	IGeneralSettingContext
	General setting interface. More...

class	ITestVideoDeviceHelperEvent
	Video Device test callback event. More...

class	ITestVideoDeviceHelper
	Video device test interface. More...

class	ILipSyncAvatarPreviewHelperEvent
	lip-sync avatar callback event. More...

class	ILipSyncAvatarPreviewHelper
	lip-sync avatar preview helper interface. More...

class	I3DAvatarImageInfo
	3D avatar image information interface. More...

class	IVideoSettingContextEvent
	Video setting context callback event. More...

struct	AutoFramingParameter
	Auto framing parameters. More...

class	IVideoSettingContext
	Video setting interface. More...

class	IAudioSettingContextEvent
	Audio setting context callback event. More...

class	IAudioSettingContext
	Audio setting interface. More...

class	IRecordingSettingContextEvent
	Recording setting context callback event. More...

class	IRecordingSettingContext
	Recording setting interface. More...

struct	tagOverallStatisticInfo
	Overall statistic information. More...

struct	tagAudioSessionStatisticInfo
	The audio status information. More...

struct	tagASVSessionStatisticInfo
	The video status information. More...

class	IStatisticSettingContext
	Statistic setting interface. More...

class	IWallpaperItem
	Wall-paper item interface. More...

class	IWallpaperSettingContextEvent
	Meeting wall-paper context Callback Event. More...

class	IWallpaperSettingContext
	Meeting Wall-paper setting interface. More...

class	IAccessibilitySettingContext
	Accessibility setting interface. More...

class	ISettingUIStrategy
	Setting user strategy interface. More...

class	IVirtualBGImageInfo
	Virtual background image information interface. More...

class	IVirtualBGSettingContextEvent
	Virtual background context Callback Event. More...

class	IVirtualBGSettingContext
	Virtual background setting interface. More...

class	IVideoFilterImageInfo
	Video filter image information interface. More...

class	IVideoFilterSettingContextEvent
	Video filter context Callback Event. More...

class	IVideoFilterSettingContext
	Video filter setting interface. More...

class	I3DAvatarSettingContextEvent
	3D avatar context callback event. More...

class	I3DAvatarSettingContext
	3D avatar setting interface. More...

class	IFaceMakeupImageInfo
	face makeup image information interface. More...

class	IFaceMakeupSettingContextEvent
	Face makeup context callback event. More...

class	IFaceMakeupSettingContext
	face makeup setting interface. More...

class	IShareSettingContext
	Share setting interface. More...

class	ISettingService
	Meeting setting interface. More...

Typedefs
typedef enum tagReactionSkinToneType	ReactionSkinToneType
	Enumeration of the skin tone type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323.

typedef struct tagShowSettingDlgParam	ShowSettingDlgParam
	The parameter to show the meeting setting dialog in Zoom UI.

typedef struct tagSettingDlgShowTabPageOption	SettingDlgShowTabPageOption
	Define the strategy to show the tab pages in the setting dialog.

typedef struct tagSettingDlgShowUrlOption	SettingDlgShowUrlOption
	Define the strategy to show the url in the setting dialog.

typedef enum PREVIEW_VIDEO_ROTATION_ACTION *	PPREVIEW_VIDEO_ROTATION_ACTION

typedef struct tagOverallStatisticInfo	OverallStatisticInfo
	Overall statistic information.

typedef struct tagAudioSessionStatisticInfo	AudioSessionStatisticInfo
	The audio status information.

typedef struct tagASVSessionStatisticInfo	ASVSessionStatisticInfo
	The video status information.

Enumerations
enum	LimitFPSValue { limitfps_Not_Enable , limitfps_1_frame , limitfps_2_frame , limitfps_4_frame , limitfps_6_frame , limitfps_8_frame , limitfps_10_frame , limitfps_15_frame }
	Enumeration of the values to limit fps. More...

enum	tagReactionSkinToneType { ReactionSkinTone_None = 0 , ReactionSkinTone_Default , ReactionSkinTone_Light , ReactionSkinTone_MediumLight , ReactionSkinTone_Medium , ReactionSkinTone_MediumDark , ReactionSkinTone_Dark }
	Enumeration of the skin tone type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323. More...

enum	ZoomSDKUITheme { ZoomSDKUITheme_Bloom , ZoomSDKUITheme_Rose , ZoomSDKUITheme_Agave , ZoomSDKUITheme_Classic }
	Enumeration of the UI theme. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061932. More...

enum	ZoomSDKUIAppearance { ZoomSDKUIAppearance_Light = 1 , ZoomSDKUIAppearance_Dark , ZoomSDKUIAppearance_System }
	Enumeration of the UI Appearance. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061932. More...

enum	WindowSizeType { WindowSize_None = 0 , WindowSize_FullScreen , WindowSize_Maximize , WindowSize_CurrentSize }
	Enumeration of the windows size when share. More...

enum	SettingTabPage { SettingTabPage_General , SettingTabPage_Audio , SettingTabPage_Video }
	Enumeration of the shown tab page at the top of the displayed setting dialog. More...

enum	ScreenCaptureMode { CaptureMode_auto = 0 , CaptureMode_legacy , CaptureMode_gpu_copy_filter , CaptureMode_ada_copy_filter , CaptureMode_ada_copy_without_filter , CaptureMode_ada_secure_filter , CaptureMode_end }
	Enumeration of the mode for screen capture. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063824. More...

enum	ShareOptionInMeeting { ShareOptionInMeeting_AllOption , ShareOptionInMeeting_AutoShareDesktop }
	Enumeration of screen sharing options when setting the page share screen item. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612. More...

enum	ShareOptionToRoom { ShareOptionToRoom_AllOption , ShareOptionToRoom_AutoShareDesktop }
	Enumeration of screen sharing options when you share directly to a Zoom Room. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612. More...

enum	ShareSelectMode { SelectMode_None = 0 , SelectMode_Window , SelectMode_Process }
	Enumeration of share select mode. More...

enum	SDK_TESTMIC_STATUS { enuCanTest = 0 , enuMicRecording , enuCanPlay }
	Enumeration of the status of the mic when testing. More...

enum	Suppress_Background_Noise_Level { Suppress_BGNoise_Level_None = 0 , Suppress_BGNoise_Level_Auto , Suppress_BGNoise_Level_Low , Suppress_BGNoise_Level_Medium , Suppress_BGNoise_Level_High }
	Enumeration of the level to suppress background noise. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985. More...

enum	PREVIEW_VIDEO_ROTATION_ACTION { PREVIEW_VIDEO_ROTATION_ACTION_0 , PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90 , PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180 , PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90 }
	Enumeration of rotation the video preview based on the current view. More...

enum	VIDEO_HARDWARE_ENCODE_TYPE { VIDEO_HARDWARE_ENCODE_RECEIVING = 0 , VIDEO_HARDWARE_ENCODE_SENDING , VIDEO_HARDWARE_ENCODE_PROCESSING }
	Enumeration of hardware acceleration. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515. More...

enum	VIDEO_LIGHT_ADAPTION_TYPE { Light_Adaption_None = 0 , Light_Adaption_Auto , Light_Adaption_Manual }
	Enumeration of light adaption type. More...

enum	AutoFramingMode { AutoFramingMode_none , AutoFramingMode_center_coordinates , AutoFramingMode_face_recognition }
	Enumeration of the auto framing modes in video. More...

enum	FaceRecognitionFailStrategy { FaceRecognitionFailStrategy_none , FaceRecognitionFailStrategy_remain , FaceRecognitionFailStrategy_using_center_coordinates , FaceRecognitionFailStrategy_using_original_video }
	Enumeration of the face recognition failure strategies. More...

enum	SDK_AUDIO_DEVICE_RAW_MODE_TYPE { SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT , SDK_AUDIO_DEVICE_RAW_MODE_ON , SDK_AUDIO_DEVICE_RAW_MODE_OFF }
	Enumeration of signal processing by Windows audio device drivers. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...

enum	SDK_ECHO_CANCELLATION_LEVEL { SDK_ECHO_CANCELLATION_DEFAULT = 0 , SDK_ECHO_CANCELLATION_AGGRESSIVE }
	Enumeration for echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...

enum	SettingsNetWorkType { SETTINGS_NETWORK_WIRED = 0 , SETTINGS_NETWORK_WIFI = 1 , SETTINGS_NETWORK_PPP = 2 , SETTINGS_NETWORK_3G = 3 , SETTINGS_NETWORK_OTHERS = 4 , SETTINGS_NETWORK_UNKNOWN = -1 }
	Enumeration of the network type. More...

enum	SettingConnectionType { SETTINGS_CONNECTION_TYPE_CLOUD , SETTINGS_CONNECTION_TYPE_DIRECT , SETTINGS_CONNECTION_TYPE_UNKNOWN = -1 }
	Enumeration of the connection type. More...

enum	ZoomSDKWallpaperLayoutMode { ZoomSDKWallpaperLayoutMode_None , ZoomSDKWallpaperLayoutMode_Fill , ZoomSDKWallpaperLayoutMode_Fit }

enum	ZoomSDKWallpaperSettingStatus { ZoomSDKWallpaperSettingStatus_None , ZoomSDKWallpaperSettingStatus_Downloading , ZoomSDKWallpaperSettingStatus_Downloaded , ZoomSDKWallpaperSettingStatus_DownloadFail }

enum	VBVideoError { VB_VideoError_None = 0 , VB_VideoError_UnknownFormat , VB_VideoError_ResolutionHigh1080P , VB_VideoError_ResolutionHigh720P , VB_VideoError_ResolutionLow , VB_VideoError_PlayError , VB_VideoError_OpenError }

enum	ZoomSDKVideoEffectType { ZoomSDKVideoEffectType_None = 0 , ZoomSDKVideoEffectType_Filter = 1 , ZoomSDKVideoEffectType_Frame = 2 , ZoomSDKVideoEffectType_CustomFilter = 3 , ZoomSDKVideoEffectType_Sticker = 4 }

enum	ZoomSDKFaceMakeupType { ZoomSDKFaceMakeupType_Mustache , ZoomSDKFaceMakeupType_Eyebrow , ZoomSDKFaceMakeupType_Lip }

Detailed Description

Configure Service Interface.

Definition in file setting_service_interface.h.

Typedef Documentation

◆ ASVSessionStatisticInfo

typedef struct tagASVSessionStatisticInfo ASVSessionStatisticInfo

The video status information.

◆ AudioSessionStatisticInfo

typedef struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo

The audio status information.

◆ OverallStatisticInfo

typedef struct tagOverallStatisticInfo OverallStatisticInfo

Overall statistic information.

◆ PPREVIEW_VIDEO_ROTATION_ACTION

typedef enum PREVIEW_VIDEO_ROTATION_ACTION * PPREVIEW_VIDEO_ROTATION_ACTION

◆ ReactionSkinToneType

typedef enum tagReactionSkinToneType ReactionSkinToneType

Enumeration of the skin tone type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323.

◆ SettingDlgShowTabPageOption

typedef struct tagSettingDlgShowTabPageOption SettingDlgShowTabPageOption

Define the strategy to show the tab pages in the setting dialog.

◆ SettingDlgShowUrlOption

typedef struct tagSettingDlgShowUrlOption SettingDlgShowUrlOption

Define the strategy to show the url in the setting dialog.

◆ ShowSettingDlgParam

typedef struct tagShowSettingDlgParam ShowSettingDlgParam

The parameter to show the meeting setting dialog in Zoom UI.

Enumeration Type Documentation

◆ AutoFramingMode

enum AutoFramingMode

Enumeration of the auto framing modes in video.

Enumerator
AutoFramingMode_none	No auto framing.
AutoFramingMode_center_coordinates	Use the video frame's center point as the center to zoom in.
AutoFramingMode_face_recognition	Use the detected face in the video frame as the center to zoom in.

Definition at line 906 of file setting_service_interface.h.

{
 
    AutoFramingMode_none,
 
    AutoFramingMode_center_coordinates,
 
    AutoFramingMode_face_recognition,
};

◆ FaceRecognitionFailStrategy

enum FaceRecognitionFailStrategy

Enumeration of the face recognition failure strategies.

Enumerator
FaceRecognitionFailStrategy_none	No use of the fail strategy.
FaceRecognitionFailStrategy_remain	After face recognition fails, do nothing until face recognition succeeds again.
FaceRecognitionFailStrategy_using_center_coordinates	After face recognition fails, use the video frame's center point as the center for zoom in.
FaceRecognitionFailStrategy_using_original_video	After face recognition fails, use original video.

Definition at line 919 of file setting_service_interface.h.

{
 
    FaceRecognitionFailStrategy_none,
 
    FaceRecognitionFailStrategy_remain,
 
    FaceRecognitionFailStrategy_using_center_coordinates,
 
    FaceRecognitionFailStrategy_using_original_video,
};

◆ LimitFPSValue

enum LimitFPSValue

Enumeration of the values to limit fps.

Enumerator
limitfps_Not_Enable	The feature is not enabled.
limitfps_1_frame	1 frame per second.
limitfps_2_frame	2 frame per second.
limitfps_4_frame	4 frame per second.
limitfps_6_frame	6 frame per second.
limitfps_8_frame	8 frame per second.
limitfps_10_frame	10 frame per second.
limitfps_15_frame	15 frame per second.

Definition at line 125 of file setting_service_interface.h.

{
 
    limitfps_Not_Enable,
 
    limitfps_1_frame,
 
    limitfps_2_frame,
 
    limitfps_4_frame,
 
    limitfps_6_frame,
 
    limitfps_8_frame,
 
    limitfps_10_frame,
 
    limitfps_15_frame,
};

◆ PREVIEW_VIDEO_ROTATION_ACTION

enum PREVIEW_VIDEO_ROTATION_ACTION

Enumeration of rotation the video preview based on the current view.

Enumerator
PREVIEW_VIDEO_ROTATION_ACTION_0	No rotation.
PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90	Rotate to the left.
PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180	Rotate 180 degrees.
PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90	Rotate to the right.

Definition at line 673 of file setting_service_interface.h.

{
 
    PREVIEW_VIDEO_ROTATION_ACTION_0,
 
    PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
 
    PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
 
    PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;

◆ ScreenCaptureMode

enum ScreenCaptureMode

Enumeration of the mode for screen capture. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063824.

Enumerator
CaptureMode_auto	Automatically choose the best method to use for screen share.
CaptureMode_legacy	This mode can be applicable if you are not on the latest operating systems, or don't have certain video drivers. If this option isn't enabled, a blank screen may appear on participants' screens while the host shares their screen.
CaptureMode_gpu_copy_filter	This mode will share your screen without showing windows from the app.
CaptureMode_ada_copy_filter	This mode will share your screen, include motion detection (when you move a window or play a movie), and will not show windows from the app.
CaptureMode_ada_copy_without_filter	This mode will share your screen, include motion detection (when you move a window or play a movie), and will show windows from the app.
CaptureMode_ada_secure_filter	When selected, only the content in the window is shared.
CaptureMode_end	For end of enumeration

Definition at line 227 of file setting_service_interface.h.

{
 
    CaptureMode_auto = 0,
 
    CaptureMode_legacy,
 
    CaptureMode_gpu_copy_filter,
 
    CaptureMode_ada_copy_filter,
 
    CaptureMode_ada_copy_without_filter,
 
    CaptureMode_ada_secure_filter,
 
    CaptureMode_end,
};

◆ SDK_AUDIO_DEVICE_RAW_MODE_TYPE

enum SDK_AUDIO_DEVICE_RAW_MODE_TYPE

Enumeration of signal processing by Windows audio device drivers. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.

Enumerator

SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT

Allows Zoom Workplace to set the Windows signal processing mode for your device.

SDK_AUDIO_DEVICE_RAW_MODE_ON

on

Enables the drivers to provide a level of audio processing.

SDK_AUDIO_DEVICE_RAW_MODE_OFF

off

Puts the drivers into "Raw" mode so that the ZoomWorkplave app can receive an unprocessed signal.

Definition at line 1324 of file setting_service_interface.h.

{
 
    SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT, 
 
    SDK_AUDIO_DEVICE_RAW_MODE_ON, 
 
    SDK_AUDIO_DEVICE_RAW_MODE_OFF 
}SDK_AUDIO_DEVICE_RAW_MODE_TYPE;

◆ SDK_ECHO_CANCELLATION_LEVEL

enum SDK_ECHO_CANCELLATION_LEVEL

Enumeration for echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.

Enumerator
SDK_ECHO_CANCELLATION_DEFAULT	Automatically adjust echo cancellation, balancing CPU and performance.
SDK_ECHO_CANCELLATION_AGGRESSIVE	Better echo limitation, taking into account multiple people talking at the same time, low CPU utilization.

Definition at line 1337 of file setting_service_interface.h.

             {
 
    SDK_ECHO_CANCELLATION_DEFAULT = 0,
 
    SDK_ECHO_CANCELLATION_AGGRESSIVE,
}SDK_ECHO_CANCELLATION_LEVEL;

◆ SDK_TESTMIC_STATUS

enum SDK_TESTMIC_STATUS

Enumeration of the status of the mic when testing.

Enumerator
enuCanTest	Test the mic via TestMicStartRecording. It is useless to call TestMicStopTesting/TestMicPlayRecording in this status.
enuMicRecording	Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless to call TestMicStartRecording in this status.
enuCanPlay	Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless call TestMicStartRecording in this status.

Definition at line 381 of file setting_service_interface.h.

{
 
    enuCanTest = 0,
 
    enuMicRecording,
 
    enuCanPlay,
} SDK_TESTMIC_STATUS;

◆ SettingConnectionType

enum SettingConnectionType

Enumeration of the connection type.

Enumerator
SETTINGS_CONNECTION_TYPE_CLOUD	Cloud connection.
SETTINGS_CONNECTION_TYPE_DIRECT	Direct connection.
SETTINGS_CONNECTION_TYPE_UNKNOWN	Unknown connection.

Definition at line 1782 of file setting_service_interface.h.

{
 
    SETTINGS_CONNECTION_TYPE_CLOUD,
 
    SETTINGS_CONNECTION_TYPE_DIRECT,
 
    SETTINGS_CONNECTION_TYPE_UNKNOWN = -1,
};

◆ SettingsNetWorkType

enum SettingsNetWorkType

Enumeration of the network type.

Enumerator
SETTINGS_NETWORK_WIRED	Wired LAN.
SETTINGS_NETWORK_WIFI	WIFI.
SETTINGS_NETWORK_PPP	PPP.
SETTINGS_NETWORK_3G	3G.
SETTINGS_NETWORK_OTHERS	Others.
SETTINGS_NETWORK_UNKNOWN	Unknown network.

Definition at line 1763 of file setting_service_interface.h.

{ 
 
    SETTINGS_NETWORK_WIRED  = 0,
 
    SETTINGS_NETWORK_WIFI   = 1,
 
    SETTINGS_NETWORK_PPP    = 2,
 
    SETTINGS_NETWORK_3G     = 3,
 
    SETTINGS_NETWORK_OTHERS = 4,
 
    SETTINGS_NETWORK_UNKNOWN = -1,
};

◆ SettingTabPage

enum SettingTabPage

Enumeration of the shown tab page at the top of the displayed setting dialog.

Enumerator
SettingTabPage_General	General setting page is on top.
SettingTabPage_Audio	Audio setting page is on top.
SettingTabPage_Video	Video setting page is on top.

Definition at line 214 of file setting_service_interface.h.

{
 
    SettingTabPage_General,
 
    SettingTabPage_Audio,
 
    SettingTabPage_Video,
};

◆ ShareOptionInMeeting

enum ShareOptionInMeeting

Enumeration of screen sharing options when setting the page share screen item. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.

Enumerator
ShareOptionInMeeting_AllOption	Show all sharing options.
ShareOptionInMeeting_AutoShareDesktop	Automatically share desktop.

Definition at line 248 of file setting_service_interface.h.

{
 
    ShareOptionInMeeting_AllOption,
 
    ShareOptionInMeeting_AutoShareDesktop,
};

◆ ShareOptionToRoom

enum ShareOptionToRoom

Enumeration of screen sharing options when you share directly to a Zoom Room. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.

Enumerator
ShareOptionToRoom_AllOption	Show all sharing options.
ShareOptionToRoom_AutoShareDesktop	Automatically share desktop.

Definition at line 259 of file setting_service_interface.h.

{
 
    ShareOptionToRoom_AllOption,
 
    ShareOptionToRoom_AutoShareDesktop,
};

◆ ShareSelectMode

enum ShareSelectMode

Enumeration of share select mode.

Enumerator
SelectMode_None	None.
SelectMode_Window	window mode.
SelectMode_Process	process mode.

Definition at line 270 of file setting_service_interface.h.

{
 
    SelectMode_None = 0,
 
    SelectMode_Window,
 
    SelectMode_Process,
};

◆ Suppress_Background_Noise_Level

enum Suppress_Background_Noise_Level

Enumeration of the level to suppress background noise. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985.

Enumerator
Suppress_BGNoise_Level_None	For initialization.
Suppress_BGNoise_Level_Auto	Automatically adjust noise suppression.
Suppress_BGNoise_Level_Low	Low level suppression. Allows faint background.
Suppress_BGNoise_Level_Medium	Medium level suppression. Filters out moderate noise like computer fan or desk taps.
Suppress_BGNoise_Level_High	High level suppression. Eliminates most background speech and persistent noise.

Definition at line 491 of file setting_service_interface.h.

{
 
    Suppress_BGNoise_Level_None = 0,
 
    Suppress_BGNoise_Level_Auto,
 
    Suppress_BGNoise_Level_Low,
 
    Suppress_BGNoise_Level_Medium,
 
    Suppress_BGNoise_Level_High,
};

◆ tagReactionSkinToneType

enum tagReactionSkinToneType

Enumeration of the skin tone type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063323.

Enumerator
ReactionSkinTone_None	Do not use any tone.
ReactionSkinTone_Default	default skin tone.
ReactionSkinTone_Light	light skin tone.
ReactionSkinTone_MediumLight	medium light skin tone.
ReactionSkinTone_Medium	medium skin tone.
ReactionSkinTone_MediumDark	medium dark skin tone.
ReactionSkinTone_Dark	dark skin tone.

Definition at line 150 of file setting_service_interface.h.

{
 
    ReactionSkinTone_None = 0,
 
    ReactionSkinTone_Default,
 
    ReactionSkinTone_Light,
 
    ReactionSkinTone_MediumLight,
 
    ReactionSkinTone_Medium,
 
    ReactionSkinTone_MediumDark,
 
    ReactionSkinTone_Dark,
}ReactionSkinToneType;

◆ VBVideoError

enum VBVideoError

Enumerator
VB_VideoError_None
VB_VideoError_UnknownFormat
VB_VideoError_ResolutionHigh1080P
VB_VideoError_ResolutionHigh720P
VB_VideoError_ResolutionLow
VB_VideoError_PlayError
VB_VideoError_OpenError

Definition at line 2198 of file setting_service_interface.h.

                  {
    VB_VideoError_None = 0,
    VB_VideoError_UnknownFormat,
    VB_VideoError_ResolutionHigh1080P,
    VB_VideoError_ResolutionHigh720P,
    VB_VideoError_ResolutionLow,
    VB_VideoError_PlayError,
    VB_VideoError_OpenError,
};

◆ VIDEO_HARDWARE_ENCODE_TYPE

enum VIDEO_HARDWARE_ENCODE_TYPE

Enumeration of hardware acceleration. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066515.

Enumerator
VIDEO_HARDWARE_ENCODE_RECEIVING	Utilizes hardware resources to improve rendering of received video feeds.
VIDEO_HARDWARE_ENCODE_SENDING	Utilizes hardware resources to improve rendering of the video feed being sent out.
VIDEO_HARDWARE_ENCODE_PROCESSING	Utilizes hardware resources to improve rendering of the overall video feeds.

Definition at line 688 of file setting_service_interface.h.

{
 
    VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
 
    VIDEO_HARDWARE_ENCODE_SENDING,
 
    VIDEO_HARDWARE_ENCODE_PROCESSING,
}VIDEO_HARDWARE_ENCODE_TYPE;

◆ VIDEO_LIGHT_ADAPTION_TYPE

enum VIDEO_LIGHT_ADAPTION_TYPE

Enumeration of light adaption type.

Enumerator
Light_Adaption_None	None.
Light_Adaption_Auto	Auto type.
Light_Adaption_Manual	Manual type.

Definition at line 870 of file setting_service_interface.h.

{
 
    Light_Adaption_None = 0,
 
    Light_Adaption_Auto,
 
    Light_Adaption_Manual,
}VIDEO_LIGHT_ADAPTION_TYPE;

◆ WindowSizeType

enum WindowSizeType

Enumeration of the windows size when share.

Enumerator
WindowSize_None	For initialization.
WindowSize_FullScreen	Full screen when share.
WindowSize_Maximize	Maximize window when share.
WindowSize_CurrentSize	Current size when share.

Definition at line 199 of file setting_service_interface.h.

{
 
    WindowSize_None = 0,
 
    WindowSize_FullScreen,
 
    WindowSize_Maximize,
 
    WindowSize_CurrentSize,
};

◆ ZoomSDKFaceMakeupType

enum ZoomSDKFaceMakeupType

Enumerator
ZoomSDKFaceMakeupType_Mustache
ZoomSDKFaceMakeupType_Eyebrow
ZoomSDKFaceMakeupType_Lip

Definition at line 2622 of file setting_service_interface.h.

{
    ZoomSDKFaceMakeupType_Mustache,
    ZoomSDKFaceMakeupType_Eyebrow,
    ZoomSDKFaceMakeupType_Lip
}ZoomSDKFaceMakeupType;

◆ ZoomSDKUIAppearance

enum ZoomSDKUIAppearance

Enumeration of the UI Appearance. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061932.

Enumerator
ZoomSDKUIAppearance_Light	Use the default, brighter theme.
ZoomSDKUIAppearance_Dark	Use the darker theme.
ZoomSDKUIAppearance_System	Follow the system settings for light or dark theme.

Definition at line 186 of file setting_service_interface.h.

{
 
    ZoomSDKUIAppearance_Light = 1,
 
    ZoomSDKUIAppearance_Dark,
 
    ZoomSDKUIAppearance_System,
};

◆ ZoomSDKUITheme

enum ZoomSDKUITheme

Enumeration of the UI theme. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061932.

Enumerator
ZoomSDKUITheme_Bloom	Use bloom theme.
ZoomSDKUITheme_Rose	Use rose theme.
ZoomSDKUITheme_Agave	Use agave theme.
ZoomSDKUITheme_Classic	Use classic theme.

Definition at line 171 of file setting_service_interface.h.

{
 
    ZoomSDKUITheme_Bloom,
 
    ZoomSDKUITheme_Rose,
 
    ZoomSDKUITheme_Agave,
 
    ZoomSDKUITheme_Classic,
};

◆ ZoomSDKVideoEffectType

enum ZoomSDKVideoEffectType

Enumerator
ZoomSDKVideoEffectType_None
ZoomSDKVideoEffectType_Filter
ZoomSDKVideoEffectType_Frame
ZoomSDKVideoEffectType_CustomFilter
ZoomSDKVideoEffectType_Sticker

Definition at line 2399 of file setting_service_interface.h.

{
    ZoomSDKVideoEffectType_None = 0,
    ZoomSDKVideoEffectType_Filter = 1,
    ZoomSDKVideoEffectType_Frame = 2,
    ZoomSDKVideoEffectType_CustomFilter = 3,
    ZoomSDKVideoEffectType_Sticker = 4,
}ZoomSDKVideoEffectType;

◆ ZoomSDKWallpaperLayoutMode

enum ZoomSDKWallpaperLayoutMode

Enumerator
ZoomSDKWallpaperLayoutMode_None
ZoomSDKWallpaperLayoutMode_Fill
ZoomSDKWallpaperLayoutMode_Fit

Definition at line 1910 of file setting_service_interface.h.

{
    ZoomSDKWallpaperLayoutMode_None,
    ZoomSDKWallpaperLayoutMode_Fill,
    ZoomSDKWallpaperLayoutMode_Fit
}ZoomSDKWallpaperLayoutMode;

◆ ZoomSDKWallpaperSettingStatus

enum ZoomSDKWallpaperSettingStatus

Enumerator
ZoomSDKWallpaperSettingStatus_None
ZoomSDKWallpaperSettingStatus_Downloading
ZoomSDKWallpaperSettingStatus_Downloaded
ZoomSDKWallpaperSettingStatus_DownloadFail

Definition at line 1917 of file setting_service_interface.h.

{
    ZoomSDKWallpaperSettingStatus_None,
    ZoomSDKWallpaperSettingStatus_Downloading,
    ZoomSDKWallpaperSettingStatus_Downloaded,
    ZoomSDKWallpaperSettingStatus_DownloadFail
}ZoomSDKWallpaperSettingStatus;

Data Structures

Typedefs

Enumerations