ZOOM Windows SDK  5.2.42037.1112
setting_service_interface.h
Go to the documentation of this file.
1 
6 #ifndef _SETTING_SERVICE_INTERFACE_H_
7 #define _SETTING_SERVICE_INTERFACE_H_
8 #include "zoom_sdk_def.h"
9 #include "zoom_sdk_util_define.h"
10 
11 BEGIN_ZOOM_SDK_NAMESPACE
15 {
16 public:
20  virtual const wchar_t* GetDeviceId() = 0;
21 
25  virtual const wchar_t* GetDeviceName() = 0;
26 
29  virtual bool IsSelectedDevice() = 0;
30 
31  virtual ~ICameraInfo() {};
32 };
33 
36 class IMicInfo
37 {
38 public:
42  virtual const wchar_t* GetDeviceId() = 0;
43 
47  virtual const wchar_t* GetDeviceName() = 0;
48 
51  virtual bool IsSelectedDevice() = 0;
52 
53  virtual ~IMicInfo() {};
54 };
55 
59 {
60 public:
64  virtual const wchar_t* GetDeviceId() = 0;
65 
69  virtual const wchar_t* GetDeviceName() = 0;
70 
73  virtual bool IsSelectedDevice() = 0;
74 
75  virtual ~ISpeakerInfo() {};
76 };
77 
83 {
92 };
93 
99 {
103 };
109 {
110  HWND hParent;
111  int top;
112  int left;
114  bool bShow;
115  bool bCenter;
118  {
119  hParent = NULL;
120  top = 0;
121  left = 0;
122  hSettingWnd = NULL;
123  bShow = true;
124  bCenter = false;
126  }
128 
134 {
136  bool bShowVideo;
147  {
148  bShowGeneral = true;
149  bShowVideo = true;
150  bShowAudio = true;
151  bShowShareScreen = true;
152  bShowVirtualBackGround = true;
153  bSHowRecording = true;
154  bShowStatistics = true;
155  bShowAccessibility = true;
156  bShowKeyboardShortcuts = true;
157  bShowAdvancedFeature = false;
158  bShowFeedback = false;
159  }
160 
162 
167 typedef enum
168 {
173 
175 //
177 {
178 public:
182  virtual void OnMicSpkVolumnChanged(unsigned int MicVolume, unsigned int SpkVolume) = 0;
183 
186  virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk) = 0;
187 
193  virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,bool& bHandled) = 0;
194 
196  virtual void OnSelectedAudioDeviceIsChanged() = 0;
197 };
198 
199 enum Suppress_Background_Noise_Level
200 {
201  Suppress_BGNoise_Level_None = 0,
202  Suppress_BGNoise_Level_Auto,
203  Suppress_BGNoise_Level_Low,
204  Suppress_BGNoise_Level_Medium,
205  Suppress_BGNoise_Level_High,
206 };
210 {
211 public:
217  virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;
218 
225  virtual SDKError TestMicStartRecording(const wchar_t* deviceID = NULL) = 0;
226 
231  virtual SDKError TestMicStopTesting() = 0;
232 
237  virtual SDKError TestMicPlayRecording() = 0;
238 
245  virtual SDKError TestSpeakerStartPlaying(const wchar_t* deviceID = NULL) = 0;
246 
251  virtual SDKError TestSpeakerStopPlaying() = 0;
252 
259  virtual SDKError SetTimerInterval(unsigned int timerInterval) = 0;
260 };
261 
265 {
266 public:
271  virtual SDKError EnableDualScreenMode(bool bEnable) = 0;
272 
275  virtual bool IsDualScreenModeEnabled() = 0;
276 
282  virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff) = 0;
283 
286  virtual bool IsAeroModeInSharingTurnOff() = 0;
287 
292  virtual SDKError EnableAutoFitToWindowWhenViewSharing(bool bEnable) = 0;
293 
296  virtual bool IsAutoFitToWindowWhenViewSharingEnabled() = 0;
297 
302  virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable) = 0;
303 
307 
312  virtual SDKError EnableAutoFullScreenVideoWhenViewShare(bool bEnable) = 0;
313 
317 
322  virtual SDKError EnableSplitScreenMode(bool bEnable) = 0;
323 
326  virtual bool IsSplitScreenModeEnabled() = 0;
327 
332  virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable) = 0;
333 
336  virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
337 
342  virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable) = 0;
343 
346  virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;
347 
350  virtual bool IsCurrentOSSupportAccelerateGPUWhenShare() = 0;
351 
356  virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable) = 0;
357 
362  virtual SDKError IsAccelerateGPUWhenShareEnabled(bool& bEnable) = 0;
363 
368  virtual SDKError EnableRemoteControlAllApplications(bool bEnable) = 0;
369 
372  virtual bool IsRemoteControlAllApplicationsEnabled() = 0;
373 
378  virtual SDKError EnableGreenBorderWhenShare(bool bEnable) = 0;
379 
382  virtual bool IsGreenBorderEnabledWhenShare() = 0;
383 
386  virtual bool IsLimitFPSEnabledWhenShare() = 0;
387 
392  virtual SDKError EnableLimitFPSWhenShare(bool bEnable) = 0;
393 
396 
402 
403 };
404 
409 typedef enum
410 {
415 } PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;
416 
417 typedef enum
418 {
419  VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
420  VIDEO_HARDWARE_ENCODE_SENDING,
421  VIDEO_HARDWARE_ENCODE_PROCESSING,
422 }VIDEO_HARDWARE_ENCODE_TYPE;
423 
424 typedef enum
425 {
426  Light_Adaption_None = 0,
427  Light_Adaption_Auto,
428  Light_Adaption_Manual,
429 }VIDEO_LIGHT_ADAPTION_TYPE;
430 
434 {
435 public:
437  virtual void OnNoVideoDeviceIsUseful() = 0;
438 
440  virtual void OnSelectedVideoDeviceIsChanged() = 0;
441 
443  virtual void OnNoWindowToShowPreview() = 0;
444 };
445 
449 {
450 public:
456  virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
457 
464  virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
465 
472  virtual SDKError TestVideoStartPreview(const wchar_t* deviceID = NULL) = 0;
473 
478  virtual SDKError TestVideoStopPreview() = 0;
479 
488 
489  virtual ICameraController* GetTestCameraController() = 0;
490 };
491 
494 {
495 public:
498  virtual void onComputerCamDeviceChanged(IList<ICameraInfo*>* pNewCameraList) = 0;
499 
503  virtual void onDefaultCamDeviceChanged(const wchar_t* deviceId, const wchar_t* deviceName) = 0;
504 };
508 {
509 public:
513  virtual IList<ICameraInfo* >* GetCameraList() = 0;
514 
519  virtual SDKError SelectCamera(const wchar_t* deviceId) = 0;
520 
525  virtual SDKError EnableVideoMirrorEffect(bool bEnable) = 0;
526 
529  virtual bool IsVideoMirrorEffectEnabled() = 0;
530 
535  virtual SDKError EnableFaceBeautyEffect(bool bEnable) = 0;
536 
539  virtual bool IsFaceBeautyEffectEnabled() = 0;
540 
543  virtual unsigned int GetFaceBeautyStrengthValue() = 0;
544 
549  virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue) = 0;
550 
557  virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue) = 0;
558 
561  virtual bool IsLightAdaptionEnabled() = 0;
562 
565  virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType() = 0;
566 
569  virtual double GetLightAdaptionManualValue() = 0;
570 
575  virtual SDKError EnableHDVideo(bool bEnable) = 0;
576 
579  virtual bool IsHDVideoEnabled() = 0;
580 
585  virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable) = 0;
586 
589  virtual bool IsAlwaysShowNameOnVideoEnabled() = 0;
590 
595  virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting(bool bEnable) = 0;
596 
599  virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled() = 0;
600 
605  virtual SDKError EnableAlwaysUse16v9(bool bEnable) = 0;
606 
609  virtual bool IsAlwaysUse16v9() = 0;
610 
615  virtual SDKError EnableSpotlightSelf(bool bEnable) = 0;
616 
619  virtual bool IsSpotlightSelfEnabled() = 0;
620 
625  virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
626 
629  virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
630 
635  virtual SDKError Enable49VideoesInGallaryView(bool bEnable) = 0;
636 
639  virtual bool Is49VideoesInGallaryViewEnabled() = 0;
640 
645  virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable) = 0;
646 
649  virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;
650 
656 
664 
669  virtual SDKError EnableVideoPreviewDialog(bool bEnable) = 0;
670 
673  virtual bool IsVideoPreviewDialogEnabled() = 0;
674 };
675 
678 {
679 public:
682  virtual void onComputerMicDeviceChanged(IList<IMicInfo*>* pNewMicList) = 0;
683 
686  virtual void onComputerSpeakerDeviceChanged(IList<ISpeakerInfo*>* pNewSpeakerList) = 0;
687 
691  virtual void onDefaultMicDeviceChanged(const wchar_t* deviceId, const wchar_t* deviceName) = 0;
692 
696  virtual void onDefaultSpeakerDeviceChanged(const wchar_t* deviceId, const wchar_t* deviceName) = 0;
697 };
698 
702 {
703 public:
707  virtual IList<IMicInfo* >* GetMicList() = 0;
708 
714  virtual SDKError SelectMic(const wchar_t* deviceId, const wchar_t* deviceName) = 0;
715 
719  virtual IList<ISpeakerInfo* >* GetSpeakerList() = 0;
720 
726  virtual SDKError SelectSpeaker(const wchar_t* deviceId, const wchar_t* deviceName) = 0;
727 
732  virtual SDKError EnableAutoJoinAudio(bool bEnable) = 0;
733 
736  virtual bool IsAutoJoinAudioEnabled() = 0;
737 
742  virtual SDKError EnableAutoAdjustMic(bool bEnable) = 0;
743 
746  virtual bool IsAutoAdjustMicEnabled() = 0;
747 
752  virtual SDKError EnableStereoAudio(bool bEnable) = 0;
753 
756  virtual bool IsStereoAudioEnable() = 0;
757 
762  virtual SDKError EnableMicOriginalInput(bool bEnable) = 0;
763 
766  virtual bool IsMicOriginalInputEnable() = 0;
767 
772  virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable) = 0;
773 
776  virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;
777 
782  virtual SDKError EnableAlwaysMuteMicWhenJoinVoip(bool bEnable) = 0;
783 
786  virtual bool IsAlwaysMuteMicWhenJoinVoipEnabled() = 0;
787 
792  virtual SDKError EnableSuppressAudioNotify(bool bEnable) = 0;
793 
796  virtual bool IsSuppressAudioNotifyEnabled() = 0;
797 
803 
807  virtual SDKError SetMicVol(FLOAT& value) = 0;
808 
811  virtual SDKError GetMicVol(FLOAT& value) = 0;
812 
816  virtual SDKError SetSpeakerVol(FLOAT& value) = 0;
817 
820  virtual SDKError GetSpeakerVol(FLOAT& value) = 0;
821 
829 
834  virtual SDKError EnableEchoCancellation(bool bEnable) = 0;
835 
838  virtual bool IsEchoCancellationEnabled() = 0;
839 
842  virtual Suppress_Background_Noise_Level GetSuppressBackgroundNoiseLevel() = 0;
843 
848  virtual SDKError SetSuppressBackgroundNoiseLevel(Suppress_Background_Noise_Level level) = 0;
849 
854  virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable) = 0;
855 
858  virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;
859 };
860 
863 {
864 public:
869  virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage) = 0;
870 };
871 
875 {
876 public:
881  virtual SDKError SetRecordingPath(const wchar_t* szPath) = 0;
882 
885  virtual const wchar_t* GetRecordingPath() = 0;
886 
892 
895  virtual bool CanGetCloudRecordingStorageInfo() = 0;
896 
902 
905  virtual const wchar_t* GetRecordingManagementURL() = 0;
906 
911  virtual SDKError CanGetRecordingManagementURL(bool& bEnable) = 0;
912 
917  virtual SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable) = 0;
918 
922 
927  virtual SDKError EnableMultiAudioStreamRecord(bool bEnable) = 0;
928 
931  virtual bool IsMultiAudioStreamRecordEnabled() = 0;
932 
937  virtual SDKError EnableAddTimestampWatermark(bool bEnable) = 0;
938 
941  virtual bool IsAddTimestampWatermarkEnabled() = 0;
942 
947  virtual SDKError EnableOptimizeFor3rdPartyVideoEditor(bool bEnable) = 0;
948 
951  virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled() = 0;
952 
957  virtual SDKError EnableShowVideoThumbnailWhenShare(bool bEnable) = 0;
958 
961  virtual bool IsShowVideoThumbnailWhenShareEnabled() = 0;
962 
967  virtual SDKError EnablePlaceVideoNextToShareInRecord(bool bEnable) = 0;
968 
971  virtual bool IsPlaceVideoNextToShareInRecordEnabled() = 0;
972 
973 };
974 
980 {
986 
988 };
989 
995 {
999 };
1000 
1006 {
1009  const wchar_t* proxy_addr_;
1011  {
1014  proxy_addr_ = NULL;
1015  }
1017 
1023 {
1032 
1034  {
1035  memset(this, 0, sizeof(tagAudioSessionStatisticInfo));
1036  }
1038 
1044 {
1058  {
1059  memset(this, 0, sizeof(tagASVSessionStatisticInfo));
1060  }
1062 
1063 
1067 {
1068 public:
1075 
1082 
1089 
1096 };
1097 
1101 {
1102 public:
1107  virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable) = 0;
1108 
1112  virtual SDKError IsAlwaysShowMeetingControlsEnable(bool& bEnable) = 0;
1113 };
1114 
1118 {
1119 public:
1122  virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable) = 0;
1123 
1126  virtual void DisableAccountSettingTabPage(bool bDisable) = 0;
1127 
1130  virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;
1131 };
1135 {
1136 public:
1139  virtual bool isSelected() = 0;
1140 
1144  virtual const wchar_t* GetImageFilePath() = 0;
1145 
1149  virtual const wchar_t* GetImageName() = 0;
1150 
1151  virtual ~IVirtualBGImageInfo() {};
1152 };
1153 
1154 enum VBVideoError {
1155  VB_VideoError_None = 0,
1156  VB_VideoError_UnknowFormat,
1157  VB_VideoError_ResolutionBig,
1158  VB_VideoError_ResolutionHigh720P,
1159  VB_VideoError_ResolutionLow,
1160  VB_VideoError_PlayError,
1161  VB_VideoError_OpenError,
1162 };
1163 
1167 {
1168 public:
1170  virtual void onVBImageDidDownloaded() = 0;
1171 
1174  virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
1175 
1177  virtual void onSelectedVBImageChanged() = 0;
1178 
1181  virtual void OnVideoThumbReady(const wchar_t* file_path);
1182 
1186  virtual void OnVideoThumbError(const wchar_t* file_path, VBVideoError error);
1187 
1191  virtual void OnVideoPlayError(const wchar_t* file_path, VBVideoError error);
1192 };
1193 
1196 {
1197 public:
1204 
1207  virtual bool IsSupportVirtualBG() = 0;
1208 
1211  virtual bool IsSupportSmartVirtualBG() = 0;
1212 
1215  virtual bool IsUsingGreenScreenOn() = 0;
1216 
1222  virtual SDKError SetUsingGreenScreen(bool bUse) = 0;
1223 
1226  virtual bool IsAllowToAddNewVBItem() = 0;
1227 
1230  virtual bool isAllowToRemoveVBItem() = 0;
1231 
1236  virtual SDKError AddBGImage(const wchar_t* file_path) = 0;
1237 
1242  virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
1243 
1248 
1253  virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;
1254 
1258  virtual DWORD GetBGReplaceColor() = 0;
1259 
1263  virtual SDKError BeginSelectReplaceVBColor() = 0;
1264 
1269  virtual SDKError AddBGVideo(const wchar_t* file_path) = 0;
1270 
1275  virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
1276 
1281 
1286  virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;
1287 
1293 };
1294 
1296 typedef enum
1297 {
1298  ZoomSDKVideoEffectType_None = 0,
1299  ZoomSDKVideoEffectType_Filter = 1,
1300  ZoomSDKVideoEffectType_Frame = 2,
1301  ZoomSDKVideoEffectType_Sticker = 4,
1302 }ZoomSDKVideoEffectType;
1303 
1307 {
1308 public:
1311  virtual bool isSelected() = 0;
1312 
1316  virtual const wchar_t* GetImageFilePath() = 0;
1317 
1321  virtual const wchar_t* GetImageName() = 0;
1322 
1326  virtual ZoomSDKVideoEffectType GetType() = 0;
1327 
1331  virtual int GetIndex() = 0;
1332 
1333  virtual ~IVideoFilterImageInfo() {};
1334 };
1335 
1339 {
1340 public:
1344  virtual void onVideoFilterItemDataDownloaded(ZoomSDKVideoEffectType type, int index) = 0;
1345 
1349  virtual void onVideoFilterItemDataNeedPrepare(ZoomSDKVideoEffectType type, int index) = 0;
1350 
1355  virtual void onVideoFilterItemDataReady(bool bSuccess, ZoomSDKVideoEffectType type, int index) = 0;
1356 };
1357 
1360 {
1361 public:
1368 
1369 
1372  virtual bool IsSupportVideoFilter() = 0;
1373 
1376  virtual bool IsVideoFilterEnabled() = 0;
1377 
1380  virtual bool IsVideoFilterLocked() = 0;
1381 
1386 
1391  virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;
1392 
1398 };
1399 
1403 {
1404 public:
1405 
1410  virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;
1411 
1415  virtual SDKError HideSettingDlg() = 0;
1416 
1422 
1427  virtual IAudioSettingContext* GetAudioSettings() = 0;
1428 
1433  virtual IVideoSettingContext* GetVideoSettings() = 0;
1434 
1440 
1446 
1452 
1458 
1464 
1465  virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;
1466 };
1467 END_ZOOM_SDK_NAMESPACE
1468 #endif
virtual const wchar_t * GetImageName()=0
Get the name of current image.
virtual IList< IVirtualBGImageInfo *> * GetBGImageList()=0
Get the list of the virtual background images.
virtual SDKError EnableAutoJoinAudio(bool bEnable)=0
Enable or disable the audio automatically when join meeting.
Meeting setting interface.
Definition: setting_service_interface.h:1402
virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk)=0
Notify that either mic device or speaker device is not found.
SettingTabPage
Specify the shown tab page at the top of the displayed setting dialog. Here are more detailed enum de...
Definition: setting_service_interface.h:98
virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo *pImage)=0
Specify an image to be the video filter image.
virtual bool IsEchoCancellationEnabled()=0
Check whether the echo cancellation is enabled or not.
virtual SDKError UseBGImage(IVirtualBGImageInfo *pImage)=0
Specify an image to be the virtual background image.
virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable)=0
Enable or disable to show the username on the video.
Definition: zoom_sdk_util_define.h:18
virtual void onVideoFilterItemDataNeedPrepare(ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item needs to download.
virtual const wchar_t * GetImageFilePath()=0
Get the file path of current image.
Video filter setting interface.
Definition: setting_service_interface.h:1359
virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable)=0
Enable/Disable the GPU acceleration when user shares.
virtual bool IsGreenBorderEnabledWhenShare()=0
Determine if the green border is enabled when user shares.
Definition: setting_service_interface.h:108
virtual bool IsShowMyMeetingElapseTimeEnabled()=0
Determine if showing elapsed time of the meeting is enabled.
virtual int GetIndex()=0
Get the index of current image.
virtual void OnVideoThumbReady(const wchar_t *file_path)
Callback event of notification that creating the thumb of a virtual background video is success...
SettingsNetWorkType net_work_type_
Network type.
Definition: setting_service_interface.h:1007
virtual SDKError EnableSuppressAudioNotify(bool bEnable)=0
Enable or disable to prompt when the user joins the meeting using the third party audio...
Setting user strategy interface.
Definition: setting_service_interface.h:1117
const wchar_t * proxy_addr_
Proxy address.
Definition: setting_service_interface.h:1009
4 frames per second.
Definition: setting_service_interface.h:87
virtual SDKError QueryOverallStatisticInfo(OverallStatisticInfo &info_)=0
Query overall statistic information.
ZOOM windows SDK Common Definition File.
Statistic setting interface.
Definition: setting_service_interface.h:1066
virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable)=0
Enable/Disable Always Show Meeting Controls in meeting window.
virtual SDKError SetTimerInterval(unsigned int timerInterval)=0
Set the time interval for audio test.
virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent *pEvent)=0
Video filter callback handler.
virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue)=0
Set the video facial beauty strength value.
virtual SDKError SelectSpeaker(const wchar_t *deviceId, const wchar_t *deviceName)=0
Select speaker device.
int latency_recv_
Receiving latency, unit: ms.
Definition: setting_service_interface.h:1027
virtual bool IsSupportVirtualBG()=0
Determine if the virtual background feature is supported by the meeting.
float packetloss_send_avg_
Sending average packet loss, unit: %.
Definition: setting_service_interface.h:1051
int resolution_recv_
HIWORD->height, LOWORD->width.
Definition: setting_service_interface.h:1054
bool bShowKeyboardShortcuts
True indicates to show keyboard shortcuts page.
Definition: setting_service_interface.h:144
virtual SDKError EnableSpotlightSelf(bool bEnable)=0
Enable or disable to spotlight the video.
virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable)=0
Enable or disable to hide the non-video participants.
virtual SDKError EnableMicOriginalInput(bool bEnable)=0
Enable or disable the original input of mic.
int jitter_send_
Sending jitter, unit: ms.
Definition: setting_service_interface.h:1028
virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable)=0
Enable or disable to press and hold the Space-bar to speak when muted.
virtual IList< IVideoFilterImageInfo *> * GetVideoFilterImageList()=0
Get the list of the video filter images.
1 frame per second.
Definition: setting_service_interface.h:85
General setting interface.
Definition: setting_service_interface.h:264
virtual bool IsSpotlightSelfEnabled()=0
Get the flag to enable/disable to spotlight video.
Video setting page.
Definition: setting_service_interface.h:102
int jitter_send_
Sending jitter, unit: ms.
Definition: setting_service_interface.h:1047
3G
Definition: setting_service_interface.h:984
Video filter image information interface.
Definition: setting_service_interface.h:1306
SettingTabPage eTabPageType
The tab page shown at the top of the displayed setting dialog.
Definition: setting_service_interface.h:116
virtual const wchar_t * GetImageName()=0
Get the name of current image.
virtual bool IsSplitScreenModeEnabled()=0
Determine if the split screen mode is enabled.
virtual SDKError ShowSettingDlg(ShowSettingDlgParam &param)=0
Display Meeting Setting dialog.
Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless call TestMicStartRecording in...
Definition: setting_service_interface.h:171
Test the mic via TestMicStartRecording. It is useless to call TestMicStopTesting/TestMicPlayRecording...
Definition: setting_service_interface.h:169
bool bShowVirtualBackGround
True indicates to show virtual background page.
Definition: setting_service_interface.h:139
float packetloss_recv_
Receiving packet loss, unit: %.
Definition: setting_service_interface.h:1031
virtual bool IsHideNoVideoUsersOnWallViewEnabled()=0
Get the flag to enable/disable to hide non-video participants.
bool bShowShareScreen
True indicates to show share screen page.
Definition: setting_service_interface.h:138
Definition: zoom_sdk_def.h:288
virtual bool Is49VideoesInGallaryViewEnabled()=0
Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen...
int latency_send_
Sending latency, unit: ms.
Definition: setting_service_interface.h:1026
virtual ZoomSDKVideoEffectType GetType()=0
Get the type of current image.
virtual bool IsAllowToAddNewVBItem()=0
Determine if the adding new virtual background item feature is supported by the meeting.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
Others.
Definition: setting_service_interface.h:985
virtual SDKError SetEvent(ITestVideoDeviceHelperEvent *pEvent)=0
Video device test callback event handler.
No rotation.
Definition: setting_service_interface.h:411
Direct connection.
Definition: setting_service_interface.h:997
virtual SDKError EnableAddTimestampWatermark(bool bEnable)=0
Enable/Disable watermark of timestamp.
virtual IStatisticSettingContext * GetStatisticSettings()=0
Get statistic settings interface.
virtual const wchar_t * GetRecordingManagementURL()=0
Get the recording management URL.
virtual IGeneralSettingContext * GetGeneralSettings()=0
Get general setting interface.
Accessibility setting interface.
Definition: setting_service_interface.h:1100
virtual bool isSelected()=0
Determine the usage of current image.
virtual SDKError TestVideoStopPreview()=0
Stop testing the camera.
float packetloss_recv_avg_
Receiving average packet loss, unit: %.
Definition: setting_service_interface.h:1052
bool bSHowRecording
True indicates to show recording page.
Definition: setting_service_interface.h:140
bool bShowVideo
True indicates to show video page.
Definition: setting_service_interface.h:136
virtual bool IsAutoAdjustMicEnabled()=0
Get the flag to enable/disable to auto-adjust the mic volume.
int latency_send_
Sending latency, unit: ms.
Definition: setting_service_interface.h:1045
bool bShowAudio
True indicates to show audio page.
Definition: setting_service_interface.h:137
virtual Suppress_Background_Noise_Level GetSuppressBackgroundNoiseLevel()=0
Get the suppress background noise level.
Virtual background image information interface.
Definition: setting_service_interface.h:1134
virtual IList< IVirtualBGImageInfo *> * GetBGVideoList()=0
Get the list of the virtual background videoes.
Unknown network.
Definition: setting_service_interface.h:987
virtual SDKError EnableFaceBeautyEffect(bool bEnable)=0
Enable or disable the video facial beauty effect.
Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless to call TestMicStartRecording...
Definition: setting_service_interface.h:170
virtual void OnNoWindowToShowPreview()=0
A window is needed to show the video preview. This event notifies that there is no window handle or a...
SettingConnectionType connection_type_
Connection type.
Definition: setting_service_interface.h:1008
virtual SDKError EnablePlaceVideoNextToShareInRecord(bool bEnable)=0
Enable/Disable placing the video layout next to the shared content in recording file.
virtual SDKError EnableVideoPreviewDialog(bool bEnable)=0
Enable or disable to show the video preview dialog when join meeting.
virtual ISettingUIStrategy * GetSettingUIStrategy()=0
Get setting user strategy interface.
virtual void onDefaultCamDeviceChanged(const wchar_t *deviceId, const wchar_t *deviceName)=0
Notify the user that a camera device is selected.
virtual const wchar_t * GetDeviceId()=0
Get the speaker device ID.
virtual bool IsAlwaysMuteMicWhenJoinVoipEnabled()=0
Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.
virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff)=0
Enable or disable the aero mode when sharing the screen.
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable)=0
Set whether to enable the function of sync buttons on headset or not.
virtual IRecordingSettingContext * GetRecordingSettings()=0
Get recording setting interface.
Audio setting interface.
Definition: setting_service_interface.h:701
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to test camera device.
HWND hParent
Parent window handle.
Definition: setting_service_interface.h:110
virtual void onDefaultSpeakerDeviceChanged(const wchar_t *deviceId, const wchar_t *deviceName)=0
Notify the user that a speaker device is selected.
int jitter_recv_
Receiving jitter, unit: ms.
Definition: setting_service_interface.h:1048
int fps_send_
Frame per second sending.
Definition: setting_service_interface.h:1055
Audio speaker device information interface.
Definition: setting_service_interface.h:58
virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable)=0
Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-...
virtual SDKError SetAudioDeviceEvent(IAudioSettingContextEvent *pEvent)=0
Audio device monitor callback event.
Wired LAN.
Definition: setting_service_interface.h:981
Unknown connection.
Definition: setting_service_interface.h:998
virtual void onComputerSpeakerDeviceChanged(IList< ISpeakerInfo *> *pNewSpeakerList)=0
Callback event if the SDK detects that the computer speaker devices have been changed.
float packetloss_send_
Sending packet loss, unit: %.
Definition: setting_service_interface.h:1030
virtual IAccessibilitySettingContext * GetAccessibilitySettings()=0
Get Accessibility settings interface.
virtual const wchar_t * GetImageFilePath()=0
Get the file path of current image.
virtual bool IsAutoJoinAudioEnabled()=0
Get the flag to enable/disable the audio automatically when join meeting.
8 frames per second.
Definition: setting_service_interface.h:89
virtual void onVideoFilterItemDataReady(bool bSuccess, ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item whether has been downloaded succes...
virtual LimitFPSValue GetLimitFPSValueWhenShare()=0
Get the limited sharing fps value when the &#39;limited sharing fps&#39; feature is enabled.
virtual SDKError QueryVideoStatisticInfo(ASVSessionStatisticInfo &info_)=0
Query video statistic information.
10 frames per second.
Definition: setting_service_interface.h:90
virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action)=0
Rotate the video preview.
Video setting context callback event.
Definition: setting_service_interface.h:493
Video device test interface.
Definition: setting_service_interface.h:448
bool bShowAdvancedFeature
True indicates to show advance feature page.
Definition: setting_service_interface.h:141
virtual SDKError EnableStereoAudio(bool bEnable)=0
Enable or disable the stereo audio.
bool bCenter
Enable to display the dialog at the center of the screen and discard the value of top and left...
Definition: setting_service_interface.h:115
virtual bool IsDualScreenModeEnabled()=0
Determine if the dual screen mode is supported.
virtual SDKError SetRecordingSettingEvent(IRecordingSettingContextEvent *pEvent)=0
Set the event of recording settings.
virtual IList< ISpeakerInfo *> * GetSpeakerList()=0
Get the speaker device list.
virtual bool IsVideoMirrorEffectEnabled()=0
Get the flag to enable/disable the video mirror effect.
virtual SDKError QueryAudioStatisticInfo(AudioSessionStatisticInfo &info_)=0
Query audio statistic information.
virtual SDKError TestMicStartRecording(const wchar_t *deviceID=NULL)=0
Start to test the mic.
virtual const wchar_t * GetDeviceId()=0
Get the microphone device ID.
The feature is not enabled.
Definition: setting_service_interface.h:84
virtual void OnSelectedVideoDeviceIsChanged()=0
Notify the user that a camera device is selected during the test, then the SDK will close the video t...
virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable)=0
Enable/Disable to show the elapsed time of the meeting.
Audio device testing callback events.
Definition: setting_service_interface.h:176
virtual SDKError EnableAutoFullScreenVideoWhenViewShare(bool bEnable)=0
Enable or disable to enter the full screen video mode automatically when viewing the sharing...
virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled()=0
Get the flag to enable to turn off the video when join meeting.
virtual SDKError EnableDualScreenMode(bool bEnable)=0
Enable or disable dual screen mode.
HWND hSettingWnd
Window handle of the dialog setting.
Definition: setting_service_interface.h:113
virtual bool IsPlaceVideoNextToShareInRecordEnabled()=0
Determine if placing video next to the shared content in recording file is enabled.
virtual SDKError RemoveBGVideo(IVirtualBGImageInfo *pRemoveVideo)=0
Remove a video from the virtual background video list.
virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting(bool bEnable)=0
Enable or disable to turn off the video when join meeting.
virtual double GetLightAdaptionManualValue()=0
Get the manual setting value for the light adaption of the video.
virtual void DisableAccountSettingTabPage(bool bDisable)=0
Hide the Account Setting page or not.
virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue)=0
Enable or disable the light adaption of the video.
Cloud connection.
Definition: setting_service_interface.h:996
virtual IList< IMicInfo *> * GetMicList()=0
Get the mic device list.
virtual SDKError IsAccelerateGPUWhenShareEnabled(bool &bEnable)=0
Determine if GPU acceleration is enabled when user shares.
virtual bool IsAutoFullScreenVideoWhenViewShareEnabled()=0
Determine if it is enable to enter the full screen video mode automatically when viewing the sharing...
virtual SDKError EnableMultiAudioStreamRecord(bool bEnable)=0
Enable/Disable multi-audio stream recording.
virtual bool IsAddTimestampWatermarkEnabled()=0
Determine if the watermark of timestamps is enabled.
virtual SDKError EnableAutoAdjustMic(bool bEnable)=0
Enable or disable the auto-adjust mic volume.
virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType()=0
Get the light adaption type of the video.
SettingsNetWorkType
Notify network type. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:979
virtual SDKError SetRecordingPath(const wchar_t *szPath)=0
Set the path to save the recording file.
virtual SDKError EnableGreenBorderWhenShare(bool bEnable)=0
Set the visibility of the green border when sharing the application.
virtual bool IsVideoFilterLocked()=0
Determine if the video filter feature is locked.
virtual bool IsHDVideoEnabled()=0
Get the flag to enable/disable the HD video.
bool bShowStatistics
True indicates to show staticstics page.
Definition: setting_service_interface.h:142
int top
The Y-axis value of the top-left corner of the dialog uses the coordinate system of the monitor...
Definition: setting_service_interface.h:111
virtual IAudioSettingContext * GetAudioSettings()=0
Get audio setting interface.
virtual bool IsSyncButtonsOnHeadsetEnabled()=0
Check whether the sync buttons on headset is enabled or not.
Microphone device information interface.
Definition: setting_service_interface.h:36
int frequency_send_
Sending frequency, unit: KHz.
Definition: setting_service_interface.h:1024
virtual IList< ICameraInfo *> * GetCameraList()=0
Get camera device list.
virtual SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable)=0
Set whether to enable the function of selecting the path to save the recording file after meeting...
virtual SDKError UseBGVideo(IVirtualBGImageInfo *pImage)=0
Specify a video to be the virtual background video.
virtual SDKError EnableAutoFitToWindowWhenViewSharing(bool bEnable)=0
Enable or disable to auto-fit the ZOOM window when viewing the shared content.
virtual IVideoSettingContext * GetVideoSettings()=0
Get video setting interface.
virtual void OnNoVideoDeviceIsUseful()=0
Notify that no camera device is found.
virtual void onVBImageDidDownloaded()=0
Callback event of notification that the default virtual background images supplied by ZOOM are downlo...
virtual SDKError EnableVideoMirrorEffect(bool bEnable)=0
Enable or disable video mirror effect.
virtual bool IsVideoPreviewDialogEnabled()=0
Get the flag to enable to show the video preview dialog when join meeting.
virtual bool IsLimitFPSEnabledWhenShare()=0
Determine if the &#39;limited sharing fps&#39; feature is enabled when user shares.
virtual bool IsVideoFilterEnabled()=0
Determine if the video filter feature is enabled.
virtual const wchar_t * GetDeviceName()=0
Get the speaker device name.
virtual SDKError AddBGImage(const wchar_t *file_path)=0
Add a new image as the virtual background image and to the image list.
General setting page.
Definition: setting_service_interface.h:100
virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
Get the flag to enable/disable the hardware acceleration.
Camera device information interface.
Definition: setting_service_interface.h:14
virtual const wchar_t * GetDeviceName()=0
Get the camera device name.
virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor)=0
Callback event of notification that the virtual background effect is updated with the selected color...
virtual const wchar_t * GetDeviceId()=0
Get the camera device ID.
Virtual background context Callback Event.
Definition: setting_service_interface.h:1166
virtual bool isAllowToRemoveVBItem()=0
Determine if the removing virtual background item feature is supported by the meeting.
virtual bool isSelected()=0
Determine the usage of current image.
float packetloss_recv_max_
Receiving max packet loss, unit: %.
Definition: setting_service_interface.h:1050
virtual bool IsUsingGreenScreenOn()=0
Determine if the green screen is using for the virtual background feature in the meeting.
virtual bool IsAutoFitToWindowWhenViewSharingEnabled()=0
Determine if it is able to auto-fit the ZOOM window when viewing the shared content.
Virtual background setting interface.
Definition: setting_service_interface.h:1195
virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
Enable or disable the hardware acceleration.
virtual SDKError EnableAlwaysUse16v9(bool bEnable)=0
Enable or disable the 16V9 video mode.
virtual const wchar_t * GetDeviceName()=0
Get the microphone device name.
virtual IVirtualBGSettingContext * GetVirtualBGSettings()=0
Get virtual background interface.
float packetloss_send_max_
Sending max packet loss, unit: %.
Definition: setting_service_interface.h:1049
virtual bool IsRemoteControlAllApplicationsEnabled()=0
Determine if remote control of all applications is enabled.
Video Device test callback event.
Definition: setting_service_interface.h:433
SDK_TESTMIC_STATUS
Notify the status of the mic when testing. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:167
Audio device test interface.
Definition: setting_service_interface.h:209
int resolution_send_
HIWORD->height, LOWORD->width.
Definition: setting_service_interface.h:1053
virtual SDKError QueryShareStatisticInfo(ASVSessionStatisticInfo &info_)=0
Query share statistic information.
PPP.
Definition: setting_service_interface.h:983
virtual SDKError AddBGVideo(const wchar_t *file_path)=0
Add a new video as the virtual background video and to the video list.
virtual SDKError TestVideoStartPreview(const wchar_t *deviceID=NULL)=0
Start to test the camera.
virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled()=0
Determine if it is able to enter the full screen video mode automatically when join meeting...
virtual void onDefaultMicDeviceChanged(const wchar_t *deviceId, const wchar_t *deviceName)=0
Notify the user that a microphone device is selected.
int fps_recv_
Frame per second receiving.
Definition: setting_service_interface.h:1056
virtual SDKError SetSpeakerVol(FLOAT &value)=0
Set the volume of the selected speaker.
virtual SDKError SetLimitFPSValueWhenShare(LimitFPSValue value)=0
Set the limited sharing fps value when the &#39;limited sharing fps&#39; feature is enabled.
virtual SDKError TestMicPlayRecording()=0
Play the mic recorded sound. If there is no mic testing, SDK return an error.
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background ...
virtual bool IsFaceBeautyEffectEnabled()=0
Get the flag to enable/disable the video facial beauty effect.
virtual DWORD GetBGReplaceColor()=0
Get the selected color after called BeginSelectReplaceVBColor() and selected a color.
virtual SDKError GetSpeakerVol(FLOAT &value)=0
Get the volume of the selected speaker.
virtual SDKError GetCloudRecordingStorageInfo()=0
Get the storage information of cloud recording.
virtual SDKError GetMicVol(FLOAT &value)=0
Get the volume of the selected mic.
virtual SDKError SetMicVol(FLOAT &value)=0
Set the volume of the selected mic.
Rotate to the left.
Definition: setting_service_interface.h:412
virtual SDKError HideSettingDlg()=0
Hide meeting setting dialog.
virtual const wchar_t * GetRecordingPath()=0
Get the path to save the recording file.
virtual bool IsAlwaysShowNameOnVideoEnabled()=0
Get the flag to enable/disable to show the username on video.
virtual SDKError SetSuppressBackgroundNoiseLevel(Suppress_Background_Noise_Level level)=0
Set the suppress background noise level.
virtual void OnMicSpkVolumnChanged(unsigned int MicVolume, unsigned int SpkVolume)=0
Notify the current mic or speaker volume when testing.
Recording setting interface.
Definition: setting_service_interface.h:874
virtual SDKError EnableShowVideoThumbnailWhenShare(bool bEnable)=0
Enable/Disable showing the video thumbnail when sharing.
virtual SDKError SetEvent(ITestAudioDeviceHelperEvent *pEvent)=0
Audio device test callback handler.
virtual bool IsAlwaysUse16v9()=0
Get the flag to enable/disable the 16V9 video mode.
virtual SDKError SelectMic(const wchar_t *deviceId, const wchar_t *deviceName)=0
Select mic device.
virtual bool IsSupportVideoFilter()=0
Determine if the video filter feature is supported by the meeting.
virtual SDKError EnableEchoCancellation(bool bEnable)=0
Set whether to enable the function of echo cancellation or not.
virtual SDKError TestMicStopTesting()=0
Stop the mic test. The SDK will return an error if there is no mic test.
virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled()=0
Determine if the third party video editor is enabled.
virtual SDKError RemoveBGImage(IVirtualBGImageInfo *pRemoveImage)=0
Remove an image from the virtual background image list.
PREVIEW_VIDEO_ROTATION_ACTION
Notify to rotate the video preview based on the current view. Here are more detailed structural descr...
Definition: setting_service_interface.h:409
bool bShowGeneral
True indicates to show general page.
Definition: setting_service_interface.h:135
virtual bool IsLightAdaptionEnabled()=0
Get the flag to enable/disable the light adaption of the video.
virtual bool IsCurrentOSSupportAccelerateGPUWhenShare()=0
Determine if the operating system supports the GPU acceleration when user shares. ...
virtual bool IsStereoAudioEnable()=0
Get the flag to enable/disable the stereo audio.
Video filter context Callback Event.
Definition: setting_service_interface.h:1338
virtual void OnSelectedAudioDeviceIsChanged()=0
Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/s...
virtual bool CanGetCloudRecordingStorageInfo()=0
Check if the user has the privilege to get the storage information for cloud recording.
int latency_recv_
Receiving latency, unit: ms.
Definition: setting_service_interface.h:1046
virtual bool IsSupportSmartVirtualBG()=0
Determine if the smart virtual background feature can be supported by the machine.
2 frames per second.
Definition: setting_service_interface.h:86
virtual SDKError Enable49VideoesInGallaryView(bool bEnable)=0
Enable or disable to show the participants in Gallery View up to 49 per screen.
virtual SDKError EnableHDVideo(bool bEnable)=0
Enable or disable HD video.
int frequency_recv_
Receiving frequency, unit: KHz.
Definition: setting_service_interface.h:1025
virtual void onComputerMicDeviceChanged(IList< IMicInfo *> *pNewMicList)=0
Callback event if the SDK detects that the computer mic devices have been changed.
virtual SDKError EnableRemoteControlAllApplications(bool bEnable)=0
Enable/disable remote control of all applications.
virtual void OnVideoThumbError(const wchar_t *file_path, VBVideoError error)
Callback event of notification that creating the thumb of a virtual background video is failed...
virtual void onComputerCamDeviceChanged(IList< ICameraInfo *> *pNewCameraList)=0
Callback event if the SDK detects that the computer camera devices have been changed.
virtual bool IsDisplayReminderWindowWhenExitEnabled()=0
Determine if reminder window is enabled when user exits the meeting.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual SDKError EnableAlwaysMuteMicWhenJoinVoip(bool bEnable)=0
Enable or disable to mute always the mic when join the meeting by VoiP.
virtual SDKError CanGetRecordingManagementURL(bool &bEnable)=0
Set if it is able to get recording management URL.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual SDKError IsAlwaysShowMeetingControlsEnable(bool &bEnable)=0
get the current setting status of Always Show Meeting Controls in meeting window. ...
virtual unsigned int GetFaceBeautyStrengthValue()=0
Get the video facial beauty strength value.
virtual SDKError SetVideoDeviceEvent(IVideoSettingContextEvent *pEvent)=0
Video device monitor callback event.
Notify the audio status information. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:1022
virtual SDKError TestSpeakerStartPlaying(const wchar_t *deviceID=NULL)=0
Start to test the speaker.
WIFI.
Definition: setting_service_interface.h:982
virtual SDKError TestSpeakerStopPlaying()=0
Stop the speaker test. The SDK will return an error if there is no speaker test.
virtual bool IsSelectRecordFileLocationAfterMeetingEnabled()=0
Check if the function of selecting storage path for recording file is enabled.
virtual SDKError EnableOptimizeFor3rdPartyVideoEditor(bool bEnable)=0
Enable/Disable the optimization for the third party video editor.
virtual bool IsSuppressAudioNotifyEnabled()=0
Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio...
LimitFPSValue
Specify the values of available limit fps. Here are more detailed enum descriptions.
Definition: setting_service_interface.h:82
Notify video status information. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:1043
virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage)=0
Notification of the current cloud recording storage information.
virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc=_SDK_TEST_VIDEO_INIT_RECT)=0
Set the window and the rectangle to display the video preview.
virtual SDKError BeginSelectReplaceVBColor()=0
Start to capture a color from video preview.
virtual SDKError EnableSplitScreenMode(bool bEnable)=0
Enable or disable to use the split screen mode, which enables the attendees to view the lectures or t...
bool bShow
Enable to display or nor.
Definition: setting_service_interface.h:114
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background ...
bool bShowFeedback
True indicates to show feed back page.
Definition: setting_service_interface.h:143
virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status, bool &bHandled)=0
Notify the mic status when testing.
virtual void onVideoFilterItemDataDownloaded(ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the thumbnail of the video filter item has been download...
virtual ITestAudioDeviceHelper * GetTestAudioDeviceHelper()=0
Get the pointer to ITestAudioDeviceHelper which is used to test audio devices.
virtual SDKError EnableLimitFPSWhenShare(bool bEnable)=0
Enable/disable the &#39;limited sharing fps&#39; feature when uses shares.
virtual SDKError SelectCamera(const wchar_t *deviceId)=0
Select camera device.
virtual bool IsHoldSpaceKeyToSpeakEnabled()=0
Get the flag to enable/disable to press and hold the Space-bar to speak.
virtual SDKError SetUsingGreenScreen(bool bUse)=0
Set to use the green screen for the virtual background feature.
virtual bool IsMultiAudioStreamRecordEnabled()=0
Determine if multi-audio stream recording is enabled.
Recording setting context callback event.
Definition: setting_service_interface.h:862
int jitter_recv_
Receiving jitter, unit: ms.
Definition: setting_service_interface.h:1029
Notify overall statistic information. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:1005
virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable)=0
Hide the link to check the advanced settings on the General Setting page or not.
virtual void OnVideoPlayError(const wchar_t *file_path, VBVideoError error)
Callback event of notification that playing a virtual background video is failed. ...
int left
The X-axis value of the top-left corner of the dialog uses the coordinate system of the monitor...
Definition: setting_service_interface.h:112
virtual bool IsShowVideoThumbnailWhenShareEnabled()=0
Determine if video thumbnail is enabled when sharing.
15 frames per second.
Definition: setting_service_interface.h:91
virtual bool IsMicOriginalInputEnable()=0
Get the flag to enable/disable the original input of mic.
SettingConnectionType
Notify connection type. Here are more detailed structural descriptions.
Definition: setting_service_interface.h:994
virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable)=0
Enable or disable to enter the full screen video mode automatically when join meeting.
6 frames per second.
Definition: setting_service_interface.h:88
virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent *pEvent)=0
Virtual background callback handler.
Rotate to the right.
Definition: setting_service_interface.h:414
Rotate 180 degrees.
Definition: setting_service_interface.h:413
virtual bool IsAeroModeInSharingTurnOff()=0
Determine if the aero mode is turned off when sharing the screen.
Audio setting context callback event.
Definition: setting_service_interface.h:677
bool bShowAccessibility
True indicates to show accessibility page.
Definition: setting_service_interface.h:145
Video setting interface.
Definition: setting_service_interface.h:507
virtual void onSelectedVBImageChanged()=0
Callback event of notification that the virtual background image is changed.
Define the strategy to show the tab pages in the setting dialog. Here are more detailed structural de...
Definition: setting_service_interface.h:133
Audio setting page.
Definition: setting_service_interface.h:101
virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption)=0
Custom the tab page show or hide.