Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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#if defined(WIN32)
10#include "zoom_sdk_util_define.h"
11#endif
12
17{
18public:
22 virtual const zchar_t* GetDeviceId() = 0;
23
27 virtual const zchar_t* GetDeviceName() = 0;
28
31 virtual bool IsSelectedDevice() = 0;
32
33 virtual ~ICameraInfo() {};
34};
35
39{
40public:
44 virtual const zchar_t* GetDeviceId() = 0;
45
49 virtual const zchar_t* GetDeviceName() = 0;
50
53 virtual bool IsSelectedDevice() = 0;
54
55 virtual ~IMicInfo() {};
56};
57
61{
62public:
66 virtual const zchar_t* GetDeviceId() = 0;
67
71 virtual const zchar_t* GetDeviceName() = 0;
72
75 virtual bool IsSelectedDevice() = 0;
76
77 virtual ~ISpeakerInfo() {};
78};
82{
83public:
87 virtual const zchar_t* GetDeviceId() = 0;
88
92 virtual const zchar_t* GetDeviceName() = 0;
93
96 virtual bool IsSelectedDevice() = 0;
97
98 virtual ~IRingSpeakerInfo() {};
99};
100
116
117
118#if defined(WIN32)
123typedef enum tagReactionSkinToneType
124{
125 ReactionSkinTone_None = 0,
126 ReactionSkinTone_Default,
127 ReactionSkinTone_Light,
128 ReactionSkinTone_MediumLight,
129 ReactionSkinTone_Medium,
130 ReactionSkinTone_MediumDark,
131 ReactionSkinTone_Dark,
132}ReactionSkinToneType;
133
134enum ZoomSDKUITheme
135{
136 ZoomSDKUITheme_Bloom,
137 ZoomSDKUITheme_Rose,
138 ZoomSDKUITheme_Agave,
139 ZoomSDKUITheme_Classic,
140};
141
142enum ZoomSDKUIAppearance
143{
144 ZoomSDKUIAppearance_Light = 1,
145 ZoomSDKUIAppearance_Dark,
146 ZoomSDKUIAppearance_System,
147};
148
149enum WindowSizeType
150{
151 WindowSize_None = 0,
152 WindowSize_FullScreen,
153 WindowSize_Maximize,
154 WindowSize_CurrentSize
155};
156
161enum SettingTabPage
162{
163 SettingTabPage_General,
164 SettingTabPage_Audio,
165 SettingTabPage_Video,
166};
167
168enum ScreenCaptureMode
169{
170 CaptureMode_auto = 0,
171 CaptureMode_legacy,
172 CaptureMode_gpu_copy_filter,
173 CaptureMode_ada_copy_filter,
174 CaptureMode_ada_copy_without_filter,
175 CaptureMode_ada_secure_filter,
176 CaptureMode_end
177};
178
179enum ShareOptionInMeeting
180{
181 ShareOptionInMeeting_AllOption,
182 ShareOptionInMeeting_AutoShareDesktop,
183};
184
185enum ShareOptionToRoom
186{
187 ShareOptionToRoom_AllOption,
188 ShareOptionToRoom_AutoShareDesktop,
189};
190
191enum ShareSelectMode
192{
193 SelectMode_None = 0,
194 SelectMode_Window,
195 SelectMode_Process,
196};
197
202typedef struct tagShowSettingDlgParam
203{
204 HWND hParent;
205 int top;
206 int left;
207 HWND hSettingWnd;
208 bool bShow;
209 bool bCenter;
210 SettingTabPage eTabPageType;
211 tagShowSettingDlgParam()
212 {
213 hParent = nullptr;
214 top = 0;
215 left = 0;
216 hSettingWnd = nullptr;
217 bShow = true;
218 bCenter = false;
219 eTabPageType = SettingTabPage_General;
220 }
221}ShowSettingDlgParam;
222
227typedef struct tagSettingDlgShowTabPageOption
228{
229 bool bShowGeneral;
230 bool bShowVideo;
231 bool bShowAudio;
232 bool bShowShareScreen;
233 bool bShowVirtualBackGround;
234 bool bSHowRecording;
235 bool bShowAdvancedFeature;
236 bool bShowStatistics;
237 bool bShowFeedback;
238 bool bShowKeyboardShortcuts;
239 bool bShowAccessibility;
240 tagSettingDlgShowTabPageOption()
241 {
242 bShowGeneral = true;
243 bShowVideo = true;
244 bShowAudio = true;
245 bShowShareScreen = true;
246 bShowVirtualBackGround = true;
247 bSHowRecording = true;
248 bShowStatistics = true;
249 bShowAccessibility = true;
250 bShowKeyboardShortcuts = true;
251 bShowAdvancedFeature = false;
252 bShowFeedback = false;
253 }
254
255}SettingDlgShowTabPageOption;
256
261typedef struct tagSettingDlgShowUrlOption
262{
263 bool bShowGeneralViewMoreSetting;
264 bool bShowVideoSupportCenter;
265 bool bShowAudioLearnMore;
266 bool bShowShareAndVBLearnMore;
267 tagSettingDlgShowUrlOption()
268 {
269 bShowGeneralViewMoreSetting = true;
270 bShowVideoSupportCenter = true;
271 bShowAudioLearnMore = true;
272 bShowShareAndVBLearnMore = true;
273 }
274
275}SettingDlgShowUrlOption;
276
281typedef enum
282{
283 enuCanTest = 0,
284 enuMicRecording,
285 enuCanPlay,
286} SDK_TESTMIC_STATUS;
287
289//
290class ITestAudioDeviceHelperEvent
291{
292public:
293 virtual ~ITestAudioDeviceHelperEvent() {}
294
298 virtual void OnMicSpkVolumeChanged(unsigned int MicVolume, unsigned int SpkVolume) = 0;
299
302 virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk) = 0;
303
309 virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,bool& bHandled) = 0;
310
312 virtual void OnSelectedAudioDeviceIsChanged() = 0;
313};
314
317class ITestAudioDeviceHelper
318{
319public:
325 virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;
326
333 virtual SDKError TestMicStartRecording(const zchar_t* deviceID = nullptr) = 0;
334
339 virtual SDKError TestMicStopTesting() = 0;
340
345 virtual SDKError TestMicPlayRecording() = 0;
346
353 virtual SDKError TestSpeakerStartPlaying(const zchar_t* deviceID = nullptr) = 0;
354
359 virtual SDKError TestSpeakerStopPlaying() = 0;
360
367 virtual SDKError SetTimerInterval(unsigned int timerInterval) = 0;
368};
369#endif
378
382{
383public:
388 virtual SDKError EnableAutoCopyInviteLink(bool bEnable) = 0;
389
392 virtual bool IsAutoCopyInviteLinkEnabled() = 0;
393
398 virtual SDKError EnableMuteWhenLockScreen(bool bEnable) = 0;
399
402 virtual bool IsMuteWhenLockScreenEnabled() = 0;
403#if defined(WIN32)
408 virtual SDKError EnableDualScreenMode(bool bEnable) = 0;
409
412 virtual bool IsDualScreenModeEnabled() = 0;
413
419 virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff) = 0;
420
423 virtual bool IsAeroModeInSharingTurnOff() = 0;
424
429 virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable) = 0;
430
433 virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled() = 0;
434
439 virtual SDKError EnableSplitScreenMode(bool bEnable) = 0;
440
443 virtual bool IsSplitScreenModeEnabled() = 0;
444
449 virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable) = 0;
450
453 virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
454
459 virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable) = 0;
460
463 virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;
464
469 virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone) = 0;
470
473 virtual ReactionSkinToneType GetReactionSkinTone() = 0;
474
477 virtual bool IsSupportSetUITheme() = 0;
478
483 virtual SDKError SetUITheme(ZoomSDKUITheme theme) = 0;
484
487 virtual ZoomSDKUITheme GetUITheme() = 0;
488
491 virtual bool IsSupportSetUIAppearance() = 0;
492
497 virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance) = 0;
498
501 virtual ZoomSDKUIAppearance GetUIAppearance() = 0;
502
503#endif
504};
505#if defined(WIN32)
510typedef enum
511{
512 PREVIEW_VIDEO_ROTATION_ACTION_0,
513 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
514 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
515 PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
516} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;
517
518typedef enum
519{
520 VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
521 VIDEO_HARDWARE_ENCODE_SENDING,
522 VIDEO_HARDWARE_ENCODE_PROCESSING,
523}VIDEO_HARDWARE_ENCODE_TYPE;
524
527class ITestVideoDeviceHelperEvent
528{
529public:
530 virtual ~ITestVideoDeviceHelperEvent() {}
531
533 virtual void OnNoVideoDeviceIsUseful() = 0;
534
536 virtual void OnSelectedVideoDeviceIsChanged() = 0;
537
539 virtual void OnNoWindowToShowPreview() = 0;
540};
541
544class ITestVideoDeviceHelper
545{
546public:
552 virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
553
560 virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
561
568 virtual SDKError TestVideoStartPreview(const zchar_t* deviceID = nullptr) = 0;
569
574 virtual SDKError TestVideoStopPreview() = 0;
575
583 virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action) = 0;
584
585 virtual ICameraController* GetTestCameraController() = 0;
586};
587
590class ILipSyncAvatarPreviewHelperEvent
591{
592public:
593 virtual ~ILipSyncAvatarPreviewHelperEvent() {}
594
596 virtual void OnNoWindowToShowLipsyncPreview() = 0;
597};
598
601class ILipSyncAvatarPreviewHelper
602{
603public:
609 virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent* pEvent) = 0;
610
617 virtual SDKError SetLipSyncAvatarPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
618
623 virtual SDKError StartLipSyncAvatarPreview() = 0;
624
629 virtual SDKError StopLipSyncAvatarPreview() = 0;
630
631 virtual ~ILipSyncAvatarPreviewHelper() {};
632};
633
636class I3DAvatarImageInfo
637{
638public:
641 virtual bool IsSelected() = 0;
642
645 virtual bool IsLastUsed() = 0;
646
650 virtual const zchar_t* GetImageFilePath() = 0;
651
655 virtual const zchar_t* GetImageName() = 0;
656
660 virtual int GetIndex() = 0;
661
662 virtual ~I3DAvatarImageInfo() {};
663};
664
665#endif
672
673
676{
677public:
679
682 virtual void onComputerCamDeviceChanged(IList<ICameraInfo*>* pNewCameraList) = 0;
683
687 virtual void onDefaultCamDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
688};
689
696
704
716
720{
721public:
726
731 virtual SDKError SelectCamera(const zchar_t* deviceId) = 0;
732
737 virtual SDKError EnableFaceBeautyEffect(bool bEnable) = 0;
738
741 virtual bool IsFaceBeautyEffectEnabled() = 0;
742
745 virtual unsigned int GetFaceBeautyStrengthValue() = 0;
746
751 virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue) = 0;
752
759 virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue) = 0;
760
763 virtual bool IsLightAdaptionEnabled() = 0;
764
768
771 virtual double GetLightAdaptionManualValue() = 0;
772
777 virtual SDKError EnableHDVideo(bool bEnable) = 0;
778
781 virtual bool IsHDVideoEnabled() = 0;
782
788
792
797 virtual SDKError EnableTemporalDeNoise(bool bEnable) = 0;
798
801 virtual bool IsTemporalDeNoiseEnabled() = 0;
802
807 virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable) = 0;
808
812
818
822
830
837
840 virtual bool IsVideoAutoFramingEnabled() = 0;
841
847
853
860 virtual SDKError SetVideoAutoFramingRatio(float ratio) = 0;
861
867
874
879
885 virtual SDKError EnableOptimizeVideoQuality(bool bEnable) = 0;
886
890
894#if defined(WIN32)
899 virtual SDKError EnableVideoMirrorEffect(bool bEnable) = 0;
900
903 virtual bool IsVideoMirrorEffectEnabled() = 0;
904
909 virtual SDKError EnableSpotlightSelf(bool bEnable) = 0;
910
913 virtual bool IsSpotlightSelfEnabled() = 0;
914
919 virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
920
923 virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
924
929 virtual SDKError Enable49VideoesInGallaryView(bool bEnable) = 0;
930
933 virtual bool Is49VideoesInGallaryViewEnabled() = 0;
934
939 virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable) = 0;
940
943 virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;
944
949 virtual SDKError EnableVideoPreviewDialog(bool bEnable) = 0;
950
953 virtual bool IsVideoPreviewDialogEnabled() = 0;
954
959 virtual SDKError EnableStopIncomingVideo(bool bEnable) = 0;
960
963 virtual bool IsStopIncomingVideoEnabled() = 0;
964
970 virtual SDKError EnableHideSelfView(bool bEnable) = 0;
971
975 virtual SDKError IsHideSelfViewEnabled(bool& bEnabled) = 0;
976
981 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
982#endif
983};
984
987{
988public:
990
993 virtual void onComputerMicDeviceChanged(IList<IMicInfo*>* pNewMicList) = 0;
994
997 virtual void onComputerSpeakerDeviceChanged(IList<ISpeakerInfo*>* pNewSpeakerList) = 0;
998
1002 virtual void onDefaultMicDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1003
1007 virtual void onDefaultSpeakerDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1008};
1009
1016
1021
1025{
1026public:
1031
1037 virtual SDKError SelectMic(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1038
1043
1049 virtual SDKError SelectSpeaker(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1050
1055 virtual SDKError EnableAutoJoinAudio(bool bEnable) = 0;
1056
1059 virtual bool IsAutoJoinAudioEnabled() = 0;
1060
1065 virtual SDKError EnableAutoAdjustMic(bool bEnable) = 0;
1066
1069 virtual bool IsAutoAdjustMicEnabled() = 0;
1070
1076
1080
1085 virtual SDKError EnableSuppressAudioNotify(bool bEnable) = 0;
1086
1090
1094 virtual SDKError SetMicVol(FLOAT& value) = 0;
1095
1098 virtual SDKError GetMicVol(FLOAT& value) = 0;
1099
1103 virtual SDKError SetSpeakerVol(FLOAT& value) = 0;
1104
1107 virtual SDKError GetSpeakerVol(FLOAT& value) = 0;
1108
1116
1120
1126
1130
1136
1140
1146
1152 virtual SDKError DisableEchoCancellation(bool bDisable) = 0;
1153
1156 virtual bool IsEchoCancellationDisabled() = 0;
1157
1159
1160 virtual SDKError GetRingSpkVolume(FLOAT& fValue) = 0;
1161
1162 virtual SDKError SetRingSpkVolume(FLOAT fValue) = 0;
1163
1164 virtual SDKError SetRingSpkDevice(const zchar_t* spk_id) = 0;
1165
1167
1169
1174 virtual SDKError EnableMicOriginalInput(bool bEnable) = 0;
1175#if defined(WIN32)
1181 virtual SDKError EnableStereoAudio(bool bEnable) = 0;
1182
1185 virtual bool IsStereoAudioEnable() = 0;
1186
1189 virtual bool IsMicOriginalInputEnable() = 0;
1190
1195 virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable) = 0;
1196
1199 virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;
1200
1205 virtual ITestAudioDeviceHelper* GetTestAudioDeviceHelper() = 0;
1206
1211 virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable) = 0;
1212
1215 virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;
1216
1222 virtual SDKError EnableHighFidelityMusicMode(bool bEnable) = 0;
1223
1226 virtual bool IsHighFidelityMusicModeDisabled() = 0;
1227
1228 virtual SDKError EnableAlwaysUseSeparateRingSpk(bool bEnable) = 0;
1229
1230 virtual bool IsAlwaysUseSeparateRingSpk() = 0;
1231
1232 virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio() = 0;
1233#endif
1234};
1235
1238{
1239public:
1241
1246 virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage) = 0;
1247};
1248
1252{
1253public:
1258 virtual SDKError SetRecordingPath(const zchar_t* szPath) = 0;
1259
1262 virtual const zchar_t* GetRecordingPath() = 0;
1263
1269
1273
1279
1283
1288 virtual SDKError CanGetRecordingManagementURL(bool& bEnable) = 0;
1289
1294 virtual SDKError EnableMultiAudioStreamRecord(bool bEnable) = 0;
1295
1299
1304 virtual SDKError EnableAddTimestampWatermark(bool bEnable) = 0;
1305
1309
1315
1319
1325
1329
1335
1339#if defined(WIN32)
1344 virtual SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable) = 0;
1345
1348 virtual bool IsSelectRecordFileLocationAfterMeetingEnabled() = 0;
1349#endif
1350
1351};
1352
1367
1378
1395
1416
1440
1441
1475
1482
1490
1494{
1495public:
1499
1502 virtual const zchar_t* GetWallpaperID() = 0;
1503
1506 virtual const zchar_t* GetTitle() = 0;
1507
1510 virtual const zchar_t* GetThumbnailPath() = 0;
1511
1514 virtual const zchar_t* GetPath() = 0;
1515
1518 virtual int GetTransparency() = 0;
1519
1522 virtual void SetTransparency(int transparency) = 0;
1523
1527
1528 virtual ~IWallpaperItem() {};
1529};
1530
1534{
1535public:
1539
1544
1545#if defined(WIN32)
1548 virtual void onPersonalWallpaperChanged(IWallpaperItem* item) = 0;
1549
1553 virtual void onPersonalWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t* wallpaperId) = 0;
1554#endif
1555};
1556
1559{
1560public:
1567
1570 virtual bool IsMeetingWallpaperEnabled() = 0;
1571
1575
1580
1584
1590
1593 virtual IWallpaperItem* GetMeetingWallpaperItemByID(const zchar_t* wallpaperID) = 0;
1594
1595#if defined(WIN32)
1598 virtual bool IsPersonalWallpaperEnabled() = 0;
1599
1603 virtual IWallpaperItem* GetCurrentPersonalWallpaperItem() = 0;
1604
1608 virtual IList<IWallpaperItem* >* GetPersonalWallpaperList() = 0;
1609
1615 virtual SDKError SetPersonalWallpaper(IWallpaperItem* item) = 0;
1616
1620 virtual IWallpaperItem* GetPersonalWallpaperItemByID(const zchar_t* wallpaperID) = 0;
1621#endif
1622};
1623
1624
1625#if defined(WIN32)
1628class IAccessibilitySettingContext
1629{
1630public:
1635 virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable) = 0;
1636
1640 virtual SDKError IsAlwaysShowMeetingControlsEnable(bool& bEnable) = 0;
1641};
1642
1645class ISettingUIStrategy
1646{
1647public:
1650 virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable) = 0;
1651
1655 virtual void DisableAccountSettingTabPage(bool bDisable) = 0;
1656
1659 virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;
1660
1663 virtual void HideAutoCopyInviteLinkCheckBox(bool bHide) = 0;
1664
1667 virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption) = 0;
1668};
1671class IVirtualBGImageInfo
1672{
1673public:
1676 virtual bool isSelected() = 0;
1677
1680 virtual bool isAllowDelete() = 0;
1684 virtual const zchar_t* GetImageFilePath() = 0;
1685
1689 virtual const zchar_t* GetImageName() = 0;
1690
1691 virtual ~IVirtualBGImageInfo() {};
1692};
1693
1694enum VBVideoError {
1695 VB_VideoError_None = 0,
1696 VB_VideoError_UnknownFormat,
1697 VB_VideoError_ResolutionHigh1080P,
1698 VB_VideoError_ResolutionHigh720P,
1699 VB_VideoError_ResolutionLow,
1700 VB_VideoError_PlayError,
1701 VB_VideoError_OpenError,
1702};
1703
1706class IVirtualBGSettingContextEvent
1707{
1708public:
1709 virtual ~IVirtualBGSettingContextEvent() {}
1710
1712 virtual void onVBImageDidDownloaded() = 0;
1713
1716 virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
1717
1719 virtual void onSelectedVBImageChanged() = 0;
1720
1723 virtual void OnVideoThumbReady(const zchar_t* file_path) = 0;
1724
1728 virtual void OnVideoThumbError(const zchar_t* file_path, VBVideoError error) = 0;
1729
1733 virtual void OnVideoPlayError(const zchar_t* file_path, VBVideoError error) = 0;
1734};
1735
1737class IVirtualBGSettingContext
1738{
1739public:
1745 virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent* pEvent) = 0;
1746
1749 virtual bool IsSupportVirtualBG() = 0;
1750
1753 virtual bool IsSupportSmartVirtualBG() = 0;
1754
1757 virtual bool IsUsingGreenScreenOn() = 0;
1758
1764 virtual SDKError SetUsingGreenScreen(bool bUse) = 0;
1765
1768 virtual bool IsAllowToAddNewVBItem() = 0;
1769
1772 virtual bool isAllowToRemoveVBItem() = 0;
1773
1778 virtual SDKError AddBGImage(const zchar_t* file_path) = 0;
1779
1784 virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
1785
1789 virtual IList<IVirtualBGImageInfo* >* GetBGImageList() = 0;
1790
1795 virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;
1796
1800 virtual DWORD GetBGReplaceColor() = 0;
1801
1805 virtual SDKError BeginSelectReplaceVBColor() = 0;
1806
1811 virtual SDKError AddBGVideo(const zchar_t* file_path) = 0;
1812
1817 virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
1818
1822 virtual IList<IVirtualBGImageInfo* >* GetBGVideoList() = 0;
1823
1828 virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;
1829
1834 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1835};
1836
1838typedef enum
1839{
1840 ZoomSDKVideoEffectType_None = 0,
1841 ZoomSDKVideoEffectType_Filter = 1,
1842 ZoomSDKVideoEffectType_Frame = 2,
1843 ZoomSDKVideoEffectType_CustomFilter = 3,
1844 ZoomSDKVideoEffectType_Sticker = 4,
1845}ZoomSDKVideoEffectType;
1846
1849class IVideoFilterImageInfo
1850{
1851public:
1854 virtual bool isSelected() = 0;
1855
1859 virtual const zchar_t* GetImageFilePath() = 0;
1860
1864 virtual const zchar_t* GetImageName() = 0;
1865
1869 virtual ZoomSDKVideoEffectType GetType() = 0;
1870
1874 virtual int GetIndex() = 0;
1875
1876 virtual ~IVideoFilterImageInfo() {};
1877};
1878
1881class IVideoFilterSettingContextEvent
1882{
1883public:
1885 virtual void onVideoFilterItemThumnailsDownloaded() = 0;
1886
1890 virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type, int index) = 0;
1891
1896 virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index) = 0;
1897};
1898
1900class IVideoFilterSettingContext
1901{
1902public:
1908 virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent* pEvent) = 0;
1909
1910
1913 virtual bool IsSupportVideoFilter() = 0;
1914
1917 virtual bool IsVideoFilterEnabled() = 0;
1918
1921 virtual bool IsVideoFilterLocked() = 0;
1922
1926 virtual IList<IVideoFilterImageInfo* >* GetVideoFilterImageList() = 0;
1927
1932 virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;
1933
1938 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1939};
1940
1943class I3DAvatarSettingContextEvent
1944{
1945public:
1946 virtual ~I3DAvatarSettingContextEvent() {}
1947
1949 virtual void on3DAvatarItemThumbnailsDownloaded() = 0;
1950
1953 virtual void on3DAvatarItemDataDownloading(int index) = 0;
1954
1958 virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index) = 0;
1959};
1960
1962class I3DAvatarSettingContext
1963{
1964public:
1970 virtual SDKError SetEvent(I3DAvatarSettingContextEvent* pEvent) = 0;
1971
1974 virtual bool Is3DAvatarSupportedByDevice() = 0;
1975
1978 virtual bool Is3DAvatarEnabled() = 0;
1979
1984 virtual SDKError Enable3DAvatarEffectForAllMeeting(bool bEnable) = 0;
1985
1988 virtual bool Is3DAvatarEffectForAllMeetingEnabled() = 0;
1989
1993 virtual IList<I3DAvatarImageInfo* >* Get3DAvatarImageList() = 0;
1994
1999 virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;
2000
2005 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2006
2011 virtual ILipSyncAvatarPreviewHelper* GetLipSyncAvatarPreviewHelper() = 0;
2012};
2013
2014typedef enum
2015{
2016 ZoomSDKFaceMakeupType_Mustache,
2017 ZoomSDKFaceMakeupType_Eyebrow,
2018 ZoomSDKFaceMakeupType_Lip
2019}ZoomSDKFaceMakeupType;
2020
2023class IFaceMakeupImageInfo
2024{
2025public:
2028 virtual ZoomSDKFaceMakeupType GetFaceMakeupType() = 0;
2029
2032 virtual bool IsSelected() = 0;
2033
2037 virtual const zchar_t* GetImageFilePath() = 0;
2038
2042 virtual const zchar_t* GetImageName() = 0;
2043
2047 virtual int GetIndex() = 0;
2048
2049 virtual ~IFaceMakeupImageInfo() {};
2050};
2051
2054class IFaceMakeupSettingContextEvent
2055{
2056public:
2057 virtual ~IFaceMakeupSettingContextEvent() {}
2058
2060 virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type) = 0;
2061
2064 virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type, int index) = 0;
2065
2069 virtual void onFaceMakeupItemDataDownloaded(bool bSuccess, ZoomSDKFaceMakeupType type, int index) = 0;
2070};
2071
2073class IFaceMakeupSettingContext
2074{
2075public:
2081 virtual SDKError SetEvent(IFaceMakeupSettingContextEvent* pEvent) = 0;
2082
2085 virtual bool IsFaceMakeupEnabled() = 0;
2086
2089 virtual bool IsSupportFaceMakeup() = 0;
2090
2095 virtual SDKError EnableFaceMakeupEffectForAllMeeting(bool bEnable) = 0;
2096
2099 virtual bool IsFaceMakeupEffectForAllMeetingEnabled() = 0;
2100
2104 virtual IList<IFaceMakeupImageInfo* >* GetFaceMakeupImageList() = 0;
2105
2110 virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo* pImage) = 0;
2111
2116 virtual SDKError SetLipsFaceMakeup(bool bEnable) = 0;
2117
2123 virtual SDKError SetColor(ZoomSDKFaceMakeupType type, unsigned long color) = 0;
2124
2130 virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type, unsigned int opactity) = 0;
2131
2135 virtual SDKError ResetAllFaceMakeupEffect() = 0;
2136
2141 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2142};
2143#endif
2144
2148{
2149public:
2150
2156
2160
2165 virtual SDKError EnableTCPConnectionWhenSharing(bool bEnable) = 0;
2166
2169 virtual bool IsTCPConnectionWhenSharing() = 0;
2170
2174
2179 virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable) = 0;
2180
2185 virtual SDKError IsAccelerateGPUWhenShareEnabled(bool& bEnable) = 0;
2186
2191 virtual SDKError EnableGreenBorderWhenShare(bool bEnable) = 0;
2192
2196
2199 virtual bool IsLimitFPSEnabledWhenShare() = 0;
2200
2205 virtual SDKError EnableLimitFPSWhenShare(bool bEnable) = 0;
2206
2209
2215
2220 virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable) = 0;
2221
2225
2229
2230
2233 virtual bool IsDoNotDisturbInSharingOn() = 0;
2234
2239 virtual SDKError EnableDoNotDisturbInSharing(bool bEnable) = 0;
2240
2246
2251 virtual SDKError IsAnnotationHardwareAccelerated(bool& bEnable) = 0;
2252
2258
2264#if defined(WIN32)
2269 virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType) = 0;
2270
2272 virtual WindowSizeType GetWindowSizeTypeWhenViewShare() = 0;
2273
2278 virtual SDKError EnableRemoteControlAllApplications(bool bEnable) = 0;
2279
2282 virtual bool IsRemoteControlAllApplicationsEnabled() = 0;
2283
2288 virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting& shareOption) = 0;
2289
2294 virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption) = 0;
2295
2300 virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode& select_mode) = 0;
2301
2306 virtual SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode) = 0;
2307
2312 virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom& share_option) = 0;
2313
2318 virtual SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option) = 0;
2319
2324 virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode) = 0;
2325
2330 virtual SDKError GetScreenCaptureMode(ScreenCaptureMode& capture_mode) = 0;
2331#endif
2332};
2333
2337{
2338public:
2339
2345
2351
2357
2363
2369
2375
2376#if defined(WIN32)
2382 virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;
2383
2388 virtual SDKError HideSettingDlg() = 0;
2389
2394 virtual IAccessibilitySettingContext* GetAccessibilitySettings() = 0;
2395
2400 virtual ISettingUIStrategy* GetSettingUIStrategy() = 0;
2401
2406 virtual IVirtualBGSettingContext* GetVirtualBGSettings() = 0;
2407
2412 virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;
2413
2418 virtual I3DAvatarSettingContext* Get3DAvatarSettings() = 0;
2419
2424 virtual IFaceMakeupSettingContext* GetFaceMakeupSettings() = 0;
2425#endif
2426
2432
2433};
2435#endif
Audio setting context callback event.
virtual void onComputerSpeakerDeviceChanged(IList< ISpeakerInfo * > *pNewSpeakerList)=0
Callback event if the SDK detects that the computer speaker devices have been changed.
virtual void onDefaultMicDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notify the user that a microphone device is selected.
virtual void onComputerMicDeviceChanged(IList< IMicInfo * > *pNewMicList)=0
Callback event if the SDK detects that the computer mic devices have been changed.
virtual void onDefaultSpeakerDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notify the user that a speaker device is selected.
Audio setting interface.
virtual bool IsAlwaysMuteMicWhenJoinVoipEnabled()=0
Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.
virtual Suppress_Background_Noise_Level GetSuppressBackgroundNoiseLevel()=0
Get the suppress background noise level.
virtual bool IsSuppressAudioNotifyEnabled()=0
Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio.
virtual SDK_AUDIO_DEVICE_RAW_MODE_TYPE GetAudioSignalProcessType()=0
Get the audio device raw mode type.
virtual SDKError UseDefaultSystemMic()=0
virtual SDKError DisableEchoCancellation(bool bDisable)=0
Set whether to disable the function of echo cancellation or not.
virtual IList< IRingSpeakerInfo * > * GetRingSpkList()=0
virtual IList< IMicInfo * > * GetMicList()=0
Get the mic device list.
virtual SDKError UseDefaultSystemSpeaker()=0
virtual SDKError SetEchoCancellationLevel(SDK_ECHO_CANCELLATION_LEVEL level)=0
Set the echo cancellation level.
virtual bool IsAutoAdjustMicEnabled()=0
Get the flag to enable/disable to auto-adjust the mic volume.
virtual SDKError EnableSuppressAudioNotify(bool bEnable)=0
Enable or disable to prompt when the user joins the meeting using the third party audio.
virtual SDKError SetSpeakerVol(FLOAT &value)=0
Set the volume of the selected speaker.
virtual SDKError SetMicVol(FLOAT &value)=0
Set the volume of the selected mic.
virtual SDKError SetRingSpkDevice(const zchar_t *spk_id)=0
virtual SDKError EnableAutoJoinAudio(bool bEnable)=0
Enable or disable the audio automatically when join meeting.
virtual bool IsEchoCancellationDisabled()=0
Check whether the echo cancellation is disabled or not.
virtual SDKError SetRingSpkVolume(FLOAT fValue)=0
virtual SDKError SetAudioDeviceEvent(IAudioSettingContextEvent *pEvent)=0
Audio device monitor callback event.
virtual SDKError GetRingSpkVolume(FLOAT &fValue)=0
virtual SDKError SelectMic(const zchar_t *deviceId, const zchar_t *deviceName)=0
Select mic device.
virtual bool IsAutoJoinAudioEnabled()=0
Get the flag to enable/disable the audio automatically when join meeting.
virtual SDKError EnableAutoAdjustMic(bool bEnable)=0
Enable or disable the auto-adjust mic volume.
virtual SDKError GetSpeakerVol(FLOAT &value)=0
Get the volume of the selected speaker.
virtual SDKError EnableAlwaysMuteMicWhenJoinVoip(bool bEnable)=0
Enable or disable to mute always the mic when join the meeting by VoiP.
virtual SDKError SetAudioSignalProcessType(SDK_AUDIO_DEVICE_RAW_MODE_TYPE type)=0
Set the audio device raw mode type.
virtual SDK_ECHO_CANCELLATION_LEVEL GetEchoCancellationLevel()=0
Get the echo cancellation level.
virtual SDKError SetSuppressBackgroundNoiseLevel(Suppress_Background_Noise_Level level)=0
Set the suppress background noise level.
virtual SDKError SelectSpeaker(const zchar_t *deviceId, const zchar_t *deviceName)=0
Select speaker device.
virtual SDKError GetMicVol(FLOAT &value)=0
Get the volume of the selected mic.
virtual SDKError EnableMicOriginalInput(bool bEnable)=0
Enable or disable the original input of mic.
virtual IList< ISpeakerInfo * > * GetSpeakerList()=0
Get the speaker device list.
Camera device information interface.
virtual const zchar_t * GetDeviceName()=0
Get the camera device name.
virtual const zchar_t * GetDeviceId()=0
Get the camera device ID.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
General setting interface.
virtual SDKError EnableAutoCopyInviteLink(bool bEnable)=0
Enable or disable to copy invite url automatically when meeting starts.
virtual bool IsMuteWhenLockScreenEnabled()=0
Determine if it is able to stop user's video and audio when user's display is off or screen save begi...
virtual bool IsAutoCopyInviteLinkEnabled()=0
Determine if it is able to automatically copy invite url when meeting starts is enabled.
virtual SDKError EnableMuteWhenLockScreen(bool bEnable)=0
Enable or disable to stop user's video and audio when user's display is off or screen save begins.
Microphone device information interface.
virtual const zchar_t * GetDeviceName()=0
Get the microphone device name.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const zchar_t * GetDeviceId()=0
Get the microphone device ID.
Recording setting context callback event.
virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage)=0
Notification of the current cloud recording storage information.
Recording setting interface.
virtual bool CanGetCloudRecordingStorageInfo()=0
Check if the user has the privilege to get the storage information for cloud recording.
virtual SDKError EnableShowVideoThumbnailWhenShare(bool bEnable)=0
Enable/Disable showing the video thumbnail when sharing.
virtual bool IsAddTimestampWatermarkEnabled()=0
Determine if the watermark of timestamps is enabled.
virtual SDKError EnableAddTimestampWatermark(bool bEnable)=0
Enable/Disable watermark of timestamp.
virtual bool IsPlaceVideoNextToShareInRecordEnabled()=0
Determine if placing video next to the shared content in recording file is enabled.
virtual const zchar_t * GetRecordingManagementURL()=0
Get the recording management URL. It returns the real url only after you retrieve the callback IRecor...
virtual const zchar_t * GetRecordingPath()=0
Get the path to save the recording file.
virtual SDKError GetCloudRecordingStorageInfo()=0
Get the storage information of cloud recording.
virtual SDKError EnablePlaceVideoNextToShareInRecord(bool bEnable)=0
Enable/Disable placing the video layout next to the shared content in recording file.
virtual bool IsShowVideoThumbnailWhenShareEnabled()=0
Determine if video thumbnail is enabled when sharing.
virtual bool IsMultiAudioStreamRecordEnabled()=0
Determine if multi-audio stream recording is enabled.
virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled()=0
Determine if the third party video editor is enabled.
virtual SDKError EnableMultiAudioStreamRecord(bool bEnable)=0
Enable/Disable multi-audio stream recording.
virtual SDKError CanGetRecordingManagementURL(bool &bEnable)=0
Set if it is able to get recording management URL.
virtual SDKError SetRecordingPath(const zchar_t *szPath)=0
Set the path to save the recording file.
virtual SDKError EnableOptimizeFor3rdPartyVideoEditor(bool bEnable)=0
Enable/Disable the optimization for the third party video editor.
virtual SDKError SetRecordingSettingEvent(IRecordingSettingContextEvent *pEvent)=0
Set the event of recording settings.
Ring speaker device information interface.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const zchar_t * GetDeviceName()=0
Get the ring speaker device name.
virtual const zchar_t * GetDeviceId()=0
Get the ring speaker device ID.
Meeting setting interface.
virtual IStatisticSettingContext * GetStatisticSettings()=0
Get statistic settings interface.
virtual IRecordingSettingContext * GetRecordingSettings()=0
Get recording setting interface.
virtual IShareSettingContext * GetShareSettings()=0
Get share settings interface.
virtual IGeneralSettingContext * GetGeneralSettings()=0
Get general setting interface.
virtual IWallpaperSettingContext * GetWallpaperSettings()=0
Get wallpaper settings interface.
virtual IVideoSettingContext * GetVideoSettings()=0
Get video setting interface.
virtual IAudioSettingContext * GetAudioSettings()=0
Get audio setting interface.
Share setting interface.
virtual bool IsCurrentOSSupportAccelerateGPUWhenShare()=0
Determine if the operating system supports the GPU acceleration when user shares.
virtual SDKError SetLimitFPSValueWhenShare(LimitFPSValue value)=0
Set the limited sharing fps value when the 'limited sharing fps' feature is enabled.
virtual SDKError EnableLimitFPSWhenShare(bool bEnable)=0
Enable/disable the 'limited sharing fps' feature when uses shares.
virtual bool IsShowMyAppWindowWhenShareEnabled()=0
Determine if it is enable to show the userself's app window when shares.
virtual LimitFPSValue GetLimitFPSValueWhenShare()=0
Get the limited sharing fps value when the 'limited sharing fps' feature is enabled.
virtual bool IsDoNotDisturbInSharingOn()=0
Determine if it is silence system notification when sharing on.
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.
virtual bool IsAutoFitToWindowWhenViewSharingEnabled()=0
Determine if it is able to auto-fit the ZOOM window when viewing the shared content.
virtual SDKError EnableGreenBorderWhenShare(bool bEnable)=0
Set the visibility of the green border when sharing the application.
virtual SDKError IsVideoSharingHardwareAccelerated(bool &bEnable)=0
Determine if GPU acceleration is enabled when a user shares video.
virtual SDKError EnableDoNotDisturbInSharing(bool bEnable)=0
Enable/Disable to silence system notification when sharing on.
virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable)=0
Enable/Disable to show the userself's app window when shares.
virtual SDKError EnableHardwareAcceleratedAnnotation(bool bEnable)=0
Enable/Disable the GPU acceleration when a user adds annotations on a shared screen or whiteboard.
virtual SDKError EnableTCPConnectionWhenSharing(bool bEnable)=0
Enable or disable TCP connecting when sharing.
virtual SDKError IsAccelerateGPUWhenShareEnabled(bool &bEnable)=0
Determine if GPU acceleration is enabled when user shares.
virtual SDKError EnableAutoFitToWindowWhenViewSharing(bool bEnable)=0
Enable or disable to auto-fit the ZOOM window when viewing the shared content.
virtual SDKError EnableHardwareAcceleratedVideoSharing(bool bEnable)=0
Enable/Disable the GPU acceleration when user shares video.
virtual SDKError IsAnnotationHardwareAccelerated(bool &bEnable)=0
Determine if GPU acceleration is enabled when user use annotations on a shared screen or whiteboard.
virtual bool IsTCPConnectionWhenSharing()=0
Determine if it is enable use TCP connection when sharing.
virtual bool IsSupportShowMyAppWindowWhenShare()=0
Determine if the feature that showing the userself's app window when shares is supported.
virtual bool IsLimitFPSEnabledWhenShare()=0
Determine if the 'limited sharing fps' feature is enabled when user shares.
Audio speaker device information interface.
virtual const zchar_t * GetDeviceId()=0
Get the speaker device ID.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const zchar_t * GetDeviceName()=0
Get the speaker device name.
Statistic setting interface.
virtual SDKError QueryOverallStatisticInfo(OverallStatisticInfo &info_)=0
Query overall statistic information.
virtual SDKError QueryShareStatisticInfo(ASVSessionStatisticInfo &info_)=0
Query share statistic information.
virtual SDKError QueryAudioStatisticInfo(AudioSessionStatisticInfo &info_)=0
Query audio statistic information.
virtual SDKError QueryVideoStatisticInfo(ASVSessionStatisticInfo &info_)=0
Query video statistic information.
Video setting context callback event.
virtual void onDefaultCamDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notify the user that a camera device is selected.
virtual void onComputerCamDeviceChanged(IList< ICameraInfo * > *pNewCameraList)=0
Callback event if the SDK detects that the computer camera devices have been changed.
Video setting interface.
virtual bool IsLightAdaptionEnabled()=0
Get the flag to enable/disable the light adaption of the video.
virtual SDKError SetVideoAutoFramingRatio(float ratio)=0
Set the zoom in ratio of auto-framing when auto-framing is enabled.
virtual SDKError GetVideoAutoFramingMode(AutoFramingMode &mode)=0
Get current mode of auto-framing.
virtual SDKError SelectCamera(const zchar_t *deviceId)=0
Select camera device.
virtual SDKError EnableVideoAutoFraming(AutoFramingMode mode, AutoFramingParameter &param)=0
Enable my video auto-framing.
virtual SDKError EnableAlwaysUseOriginalSizeVideo(bool bEnable)=0
Enable or disable always use original size video.
virtual SDKError SetFaceRecognitionFailStrategy(FaceRecognitionFailStrategy strategy)=0
Set the fail strategy of face recognition when auto-framing is enabled(mode is "AutoFramingMode_face_...
virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType()=0
Get the light adaption type of the video.
virtual bool IsOptimizeVideoQualityEnabled()=0
Determine if optimizing received video quality is enabled.
virtual unsigned int GetFaceBeautyStrengthValue()=0
Get the video facial beauty strength value.
virtual bool IsVideoAutoFramingEnabled()=0
Determine whether auto-framing is enabled.
virtual bool IsOptimizeVideoQualitySupported()=0
Determine if optimizing received video quality is supported.
virtual SDKError EnableHDVideo(bool bEnable)=0
Enable or disable HD video.
virtual IList< ICameraInfo * > * GetCameraList()=0
Get camera device list.
virtual bool IsAlwaysUseOriginalSizeVideo()=0
Get the flag to enable/disable always use original size video.
virtual SDKError SetVideoDeviceEvent(IVideoSettingContextEvent *pEvent)=0
Video device monitor callback event.
virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable)=0
Enable or disable to show the username on the video.
virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled()=0
Get the flag to enable to turn off the video when join meeting.
virtual SDKError EnableFaceBeautyEffect(bool bEnable)=0
Enable or disable the video facial beauty effect.
virtual SDKError DisableVideoAutoFraming()=0
Stop video auto-framing.
virtual SDKError SetVideoAutoFramingMode(AutoFramingMode mode)=0
Set the mode of auto-framing when auto-framing is enabled.
virtual double GetLightAdaptionManualValue()=0
Get the manual setting value for the light adaption of the video.
virtual bool IsAlwaysShowNameOnVideoEnabled()=0
Get the flag to enable/disable to show the username on video.
virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue)=0
Enable or disable the light adaption of the video.
virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue)=0
Set the video facial beauty strength value.
virtual SDKError GetVideoAutoFramingSetting(AutoFramingMode mode, AutoFramingParameter &param)=0
Get the setting of auto-framing.
virtual SDKError EnableOptimizeVideoQuality(bool bEnable)=0
Enable or disable optimizing received video quality when facing network issues for a variety of reaso...
virtual bool IsFaceBeautyEffectEnabled()=0
Get the flag to enable/disable the video facial beauty effect.
virtual bool IsHDVideoEnabled()=0
Get the flag to enable/disable the HD video.
virtual SDKError EnableTemporalDeNoise(bool bEnable)=0
Enable or disable video de-noise.
virtual bool IsTemporalDeNoiseEnabled()=0
Get the flag to enable/disable the video de-noise.
virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting(bool bEnable)=0
Enable or disable to turn off the video when join meeting.
Wall-paper item interface.
virtual void SetTransparency(int transparency)=0
Set the transparency of the wall-paper.
virtual const zchar_t * GetThumbnailPath()=0
Get the wall-paper thumbnail path.
virtual int GetTransparency()=0
Get the transparency of the wall-paper.
virtual void SetWallpaperLayoutMode(ZoomSDKWallpaperLayoutMode mode)=0
Set the layout mode of the wall-paper.
virtual const zchar_t * GetWallpaperID()=0
Get the wall-paper ID.
virtual const zchar_t * GetTitle()=0
Get the wall-paper title.
virtual ZoomSDKWallpaperLayoutMode GetWallpaperLayoutMode()=0
Get the layout mode of the wall-paper.
virtual const zchar_t * GetPath()=0
Get the full image path of the wall-paper.
Meeting wall-paper context Callback Event.
virtual void onMeetingWallpaperChanged(IWallpaperItem *item)=0
Callback event of notification that the meeting wall-paper item is changed.
virtual void onMeetingWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t *wallpaperId)=0
Callback event of notification that download status of the meeting wall-paper is changed.
Meeting Wall-paper setting interface.
virtual IWallpaperItem * GetMeetingWallpaperItemByID(const zchar_t *wallpaperID)=0
Get the meeting wall-paper item by wall-paper ID.
virtual bool IsMeetingWallpaperEnabled()=0
Determine if the meeting wall-paper feature enabled by OP.
virtual bool IsMeetingWallpaperThumbsReady()=0
Determine if meeting wall-paper thumbnail ready.
virtual IList< IWallpaperItem * > * GetMeetingWallpaperList()=0
Get the meeting wall-paper list.
virtual SDKError SetEvent(IWallpaperSettingContextEvent *pEvent)=0
Meeting wall-paper callback handler.
virtual SDKError SetMeetingWallpaper(IWallpaperItem *item)=0
Set the meeting wall-paper item.
virtual IWallpaperItem * GetCurrentMeetingWallpaperItem()=0
Get the meeting wall-paper item.
Suppress_Background_Noise_Level
@ Suppress_BGNoise_Level_Low
@ Suppress_BGNoise_Level_None
@ Suppress_BGNoise_Level_Medium
@ Suppress_BGNoise_Level_High
@ Suppress_BGNoise_Level_Auto
SettingConnectionType
Notify connection type. Here are more detailed structural descriptions.
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
Unknown connection.
@ SETTINGS_CONNECTION_TYPE_CLOUD
Cloud connection.
@ SETTINGS_CONNECTION_TYPE_DIRECT
Direct connection.
struct tagOverallStatisticInfo OverallStatisticInfo
@ ZoomSDKWallpaperSettingStatus_DownloadFail
@ ZoomSDKWallpaperSettingStatus_Downloading
@ ZoomSDKWallpaperSettingStatus_Downloaded
@ ZoomSDKWallpaperSettingStatus_None
struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
@ SDK_AUDIO_DEVICE_RAW_MODE_OFF
off
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
default mode
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
on
SettingsNetWorkType
Notify network type. Here are more detailed structural descriptions.
@ SETTINGS_NETWORK_3G
3G
@ SETTINGS_NETWORK_UNKNOWN
Unknown network.
@ SETTINGS_NETWORK_WIRED
Wired LAN.
@ SETTINGS_NETWORK_OTHERS
Others.
@ SETTINGS_NETWORK_WIFI
WIFI.
@ SETTINGS_NETWORK_PPP
PPP.
LimitFPSValue
Specify the values of available limit fps. Here are more detailed enum descriptions.
@ limitfps_2_frame
2 frames per second.
@ limitfps_Not_Enable
The feature is not enabled.
@ limitfps_8_frame
8 frames per second.
@ limitfps_15_frame
15 frames per second.
@ limitfps_10_frame
10 frames per second.
@ limitfps_1_frame
1 frame per second.
@ limitfps_4_frame
4 frames per second.
@ limitfps_6_frame
6 frames per second.
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_AGGRESSIVE
@ AutoFramingMode_center_coordinates
will use the center point of the video frame as the center for zoom-in
@ AutoFramingMode_face_recognition
will use the detected face in the video frame as the center to zoom-in
@ AutoFramingMode_none
No use of the auto-framing.
@ FaceRecognitionFailStrategy_using_original_video
After face recognition fail, will use original video.
@ FaceRecognitionFailStrategy_none
No use of the fail strategy.
@ FaceRecognitionFailStrategy_remain
After face recognition fail, do nothing util face recognition success again.
@ FaceRecognitionFailStrategy_using_center_coordinates
After face recognition fail, will use center point of the video frame as the center for zoom-in.
@ ZoomSDKWallpaperLayoutMode_Fill
@ ZoomSDKWallpaperLayoutMode_None
@ ZoomSDKWallpaperLayoutMode_Fit
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
float ratio
The zoom in ratio of auto-framing, valid range of values: 1~10(when mode is AutoFramingMode_center_co...
FaceRecognitionFailStrategy fail_Strategy
Only mode is AutoFramingMode_face_recognition, the param is valid.
Notify video status information. Here are more detailed structural descriptions.
float packetloss_recv_avg_
Receiving average packet loss, unit: %.
int jitter_recv_
Receiving jitter, unit: ms.
float packetloss_send_avg_
Sending average packet loss, unit: %.
int fps_send_
Frame per second sending.
int resolution_recv_
HIWORD->height, LOWORD->width.
int latency_send_
Sending latency, unit: ms.
int resolution_send_
HIWORD->height, LOWORD->width.
float packetloss_recv_max_
Receiving max packet loss, unit: %.
float packetloss_send_max_
Sending max packet loss, unit: %.
int fps_recv_
Frame per second receiving.
int latency_recv_
Receiving latency, unit: ms.
int jitter_send_
Sending jitter, unit: ms.
Notify the audio status information. Here are more detailed structural descriptions.
int jitter_send_
Sending jitter, unit: ms.
float packetloss_recv_
Receiving packet loss, unit: %.
int frequency_send_
Sending frequency, unit: KHz.
float packetloss_send_
Sending packet loss, unit: %.
int frequency_recv_
Receiving frequency, unit: KHz.
int latency_send_
Sending latency, unit: ms.
int latency_recv_
Receiving latency, unit: ms.
int jitter_recv_
Receiving jitter, unit: ms.
Notify overall statistic information. Here are more detailed structural descriptions.
const zchar_t * proxy_addr_
Proxy address.
SettingsNetWorkType net_work_type_
Network type.
SettingConnectionType connection_type_
Connection type.
ZOOM windows SDK Common Definition File.
int64_t INT64
void * HWND
#define END_ZOOM_SDK_NAMESPACE
float FLOAT
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
SDK error types. Here are more detailed structural descriptions.