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

struct	tagSettingDlgShowTabPageOption
	Define the strategy to show the tab pages in the setting dialog. Here are more detailed structural descriptions. More...

struct	tagSettingDlgShowUrlOption
	Define the strategy to show the url in the setting dialog. Here are more detailed structural descriptions. 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	ILipSyncAvatarSettingContextEvent
	lip sync avatar context Callback Event. More...

class	ILipSyncAvatarSettingContext
	Lip sync avatar setting interface. More...

class	IVideoSettingContextEvent
	Video setting context callback event. 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
	Notify overall statistic information. Here are more detailed structural descriptions. More...

struct	tagAudioSessionStatisticInfo
	Notify the audio status information. Here are more detailed structural descriptions. More...

struct	tagASVSessionStatisticInfo
	Notify video status information. Here are more detailed structural descriptions. More...

class	IStatisticSettingContext
	Statistic 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	IShareSettingContext
	Share setting interface. More...

class	ISettingService
	Meeting setting interface. More...

Typedefs
typedef enum tagReactionSkinToneType	ReactionSkinToneType

typedef struct tagShowSettingDlgParam	ShowSettingDlgParam

typedef struct tagSettingDlgShowTabPageOption	SettingDlgShowTabPageOption

typedef struct tagSettingDlgShowUrlOption	SettingDlgShowUrlOption

typedef enum PREVIEW_VIDEO_ROTATION_ACTION *	PPREVIEW_VIDEO_ROTATION_ACTION

typedef struct tagOverallStatisticInfo	OverallStatisticInfo

typedef struct tagAudioSessionStatisticInfo	AudioSessionStatisticInfo

typedef struct tagASVSessionStatisticInfo	ASVSessionStatisticInfo

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 }
	Specify the values of available limit fps. Here are more detailed enum descriptions. More...

enum	SettingTabPage { SettingTabPage_General , SettingTabPage_Audio , SettingTabPage_Video }
	Specify the shown tab page at the top of the displayed setting dialog. Here are more detailed enum descriptions. More...

enum	tagReactionSkinToneType { ReactionSkinTone_None = 0 , ReactionSkinTone_Default , ReactionSkinTone_Light , ReactionSkinTone_MediumLight , ReactionSkinTone_Medium , ReactionSkinTone_MediumDark , ReactionSkinTone_Dark }

enum	WindowSizeType { WindowSize_None = 0 , WindowSize_FullScreen , WindowSize_Maximize , WindowSize_CurrentSize }

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 }

enum	ShareOptionInMeeting { ShareOptionInMeeting_AllOption , ShareOptionInMeeting_AutoShareDesktop }

enum	ShareOptionToRoom { ShareOptionToRoom_AllOption , ShareOptionToRoom_AutoShareDesktop }

enum	ShareSelectMode { SelectMode_None = 0 , SelectMode_Window , SelectMode_Process }

enum	SDK_TESTMIC_STATUS { enuCanTest = 0 , enuMicRecording , enuCanPlay }
	Notify the status of the mic when testing. Here are more detailed structural descriptions. 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 }

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 }
	Notify to rotate the video preview based on the current view. Here are more detailed structural descriptions. More...

enum	VIDEO_HARDWARE_ENCODE_TYPE { VIDEO_HARDWARE_ENCODE_RECEIVING = 0 , VIDEO_HARDWARE_ENCODE_SENDING , VIDEO_HARDWARE_ENCODE_PROCESSING }

enum	VIDEO_LIGHT_ADAPTION_TYPE { Light_Adaption_None = 0 , Light_Adaption_Auto , Light_Adaption_Manual }

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 }

enum	SDK_ECHO_CANCELLATION_LEVEL { SDK_ECHO_CANCELLATION_DEFAULT = 0 , SDK_ECHO_CANCELLATION_AGGRESSIVE }

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 }
	Notify network type. Here are more detailed structural descriptions. More...

enum	SettingConnectionType { SETTINGS_CONNECTION_TYPE_CLOUD , SETTINGS_CONNECTION_TYPE_DIRECT , SETTINGS_CONNECTION_TYPE_UNKNOWN = -1 }
	Notify connection type. Here are more detailed structural descriptions. More...

enum	VBVideoError { VB_VideoError_None = 0 , VB_VideoError_UnknowFormat , 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_Sticker = 4 }

Detailed Description

Configure Service Interface.

Definition in file setting_service_interface.h.

Typedef Documentation

◆ ASVSessionStatisticInfo

typedef struct tagASVSessionStatisticInfo ASVSessionStatisticInfo

◆ AudioSessionStatisticInfo

typedef struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo

◆ OverallStatisticInfo

typedef struct tagOverallStatisticInfo OverallStatisticInfo

◆ PPREVIEW_VIDEO_ROTATION_ACTION

typedef enum PREVIEW_VIDEO_ROTATION_ACTION * PPREVIEW_VIDEO_ROTATION_ACTION

◆ ReactionSkinToneType

typedef enum tagReactionSkinToneType ReactionSkinToneType

◆ SettingDlgShowTabPageOption

typedef struct tagSettingDlgShowTabPageOption SettingDlgShowTabPageOption

◆ SettingDlgShowUrlOption

typedef struct tagSettingDlgShowUrlOption SettingDlgShowUrlOption

◆ ShowSettingDlgParam

typedef struct tagShowSettingDlgParam ShowSettingDlgParam

Enumeration Type Documentation

◆ LimitFPSValue

enum LimitFPSValue

Specify the values of available limit fps. Here are more detailed enum descriptions.

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

Definition at line 103 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

Notify to rotate the video preview based on the current view. Here are more detailed structural descriptions.

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 455 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

Enumerator
CaptureMode_auto
CaptureMode_legacy
CaptureMode_gpu_copy_filter
CaptureMode_ada_copy_filter
CaptureMode_ada_copy_without_filter
CaptureMode_ada_secure_filter
CaptureMode_end

Definition at line 148 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

Enumerator
SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
SDK_AUDIO_DEVICE_RAW_MODE_ON
SDK_AUDIO_DEVICE_RAW_MODE_OFF

Definition at line 923 of file setting_service_interface.h.

{
    SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT, //default mode
    SDK_AUDIO_DEVICE_RAW_MODE_ON, //on
    SDK_AUDIO_DEVICE_RAW_MODE_OFF //off
}SDK_AUDIO_DEVICE_RAW_MODE_TYPE;

◆ SDK_ECHO_CANCELLATION_LEVEL

enum SDK_ECHO_CANCELLATION_LEVEL

Enumerator
SDK_ECHO_CANCELLATION_DEFAULT
SDK_ECHO_CANCELLATION_AGGRESSIVE

Definition at line 930 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

Notify the status of the mic when testing. Here are more detailed structural descriptions.

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 261 of file setting_service_interface.h.

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

◆ SettingConnectionType

enum SettingConnectionType

Notify connection type. Here are more detailed structural descriptions.

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

Definition at line 1283 of file setting_service_interface.h.

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

◆ SettingsNetWorkType

enum SettingsNetWorkType

Notify network type. Here are more detailed structural descriptions.

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 1268 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

Specify the shown tab page at the top of the displayed setting dialog. Here are more detailed enum descriptions.

Enumerator
SettingTabPage_General	General setting page.
SettingTabPage_Audio	Audio setting page.
SettingTabPage_Video	Video setting page.

Definition at line 119 of file setting_service_interface.h.

{
    SettingTabPage_General,
    SettingTabPage_Audio,
    SettingTabPage_Video,
};

◆ ShareOptionInMeeting

enum ShareOptionInMeeting

Enumerator
ShareOptionInMeeting_AllOption
ShareOptionInMeeting_AutoShareDesktop

Definition at line 159 of file setting_service_interface.h.

{
    ShareOptionInMeeting_AllOption,
    ShareOptionInMeeting_AutoShareDesktop,
};

◆ ShareOptionToRoom

enum ShareOptionToRoom

Enumerator
ShareOptionToRoom_AllOption
ShareOptionToRoom_AutoShareDesktop

Definition at line 165 of file setting_service_interface.h.

{
    ShareOptionToRoom_AllOption,
    ShareOptionToRoom_AutoShareDesktop,
};

◆ ShareSelectMode

enum ShareSelectMode

Enumerator
SelectMode_None
SelectMode_Window
SelectMode_Process

Definition at line 171 of file setting_service_interface.h.

{
    SelectMode_None = 0,
    SelectMode_Window,
    SelectMode_Process,
};

◆ Suppress_Background_Noise_Level

enum Suppress_Background_Noise_Level

Enumerator
Suppress_BGNoise_Level_None
Suppress_BGNoise_Level_Auto
Suppress_BGNoise_Level_Low
Suppress_BGNoise_Level_Medium
Suppress_BGNoise_Level_High

Definition at line 295 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

Enumerator
ReactionSkinTone_None
ReactionSkinTone_Default
ReactionSkinTone_Light
ReactionSkinTone_MediumLight
ReactionSkinTone_Medium
ReactionSkinTone_MediumDark
ReactionSkinTone_Dark

Definition at line 129 of file setting_service_interface.h.

{
    ReactionSkinTone_None = 0,     //none
    ReactionSkinTone_Default,      //default skin tone
    ReactionSkinTone_Light,        //light skin tone
    ReactionSkinTone_MediumLight,  //medium light skin tone
    ReactionSkinTone_Medium,       //medium skin tone
    ReactionSkinTone_MediumDark,   //meduim dark skin tone
    ReactionSkinTone_Dark,         //dark skin tone 
}ReactionSkinToneType;

◆ VBVideoError

enum VBVideoError

Enumerator
VB_VideoError_None
VB_VideoError_UnknowFormat
VB_VideoError_ResolutionHigh1080P
VB_VideoError_ResolutionHigh720P
VB_VideoError_ResolutionLow
VB_VideoError_PlayError
VB_VideoError_OpenError

Definition at line 1454 of file setting_service_interface.h.

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

◆ VIDEO_HARDWARE_ENCODE_TYPE

enum VIDEO_HARDWARE_ENCODE_TYPE

Enumerator
VIDEO_HARDWARE_ENCODE_RECEIVING
VIDEO_HARDWARE_ENCODE_SENDING
VIDEO_HARDWARE_ENCODE_PROCESSING

Definition at line 463 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

Enumerator
Light_Adaption_None
Light_Adaption_Auto
Light_Adaption_Manual

Definition at line 470 of file setting_service_interface.h.

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

◆ WindowSizeType

enum WindowSizeType

Enumerator
WindowSize_None
WindowSize_FullScreen
WindowSize_Maximize
WindowSize_CurrentSize

Definition at line 140 of file setting_service_interface.h.

{
    WindowSize_None = 0,
    WindowSize_FullScreen,  //Full screen when share
    WindowSize_Maximize,    //Maximize window when share
    WindowSize_CurrentSize  //Current size when share
};

◆ ZoomSDKVideoEffectType

enum ZoomSDKVideoEffectType

Enumerator
ZoomSDKVideoEffectType_None
ZoomSDKVideoEffectType_Filter
ZoomSDKVideoEffectType_Frame
ZoomSDKVideoEffectType_Sticker

Definition at line 1598 of file setting_service_interface.h.

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

Data Structures

Typedefs

Enumerations