ZOOM Windows SDK  5.2.42037.1112
Classes | Typedefs | Enumerations
setting_service_interface.h File Reference

Configure Service Interface. More...

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

Go to the source code of this file.

Classes

class  ICameraInfo
 Camera device information interface. More...
 
class  IMicInfo
 Microphone device information interface. More...
 
class  ISpeakerInfo
 Audio 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...
 
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  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  ISettingService
 Meeting setting interface. More...
 

Typedefs

typedef struct tagShowSettingDlgParam ShowSettingDlgParam
 
typedef struct tagSettingDlgShowTabPageOption SettingDlgShowTabPageOption
 
typedef enum PREVIEW_VIDEO_ROTATION_ACTIONPPREVIEW_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  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  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_ResolutionBig, 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.

Enumeration Type Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.