Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
setting_service_interface.h
Go to the documentation of this file.
1
5#ifndef _SETTING_SERVICE_INTERFACE_H_
6#define _SETTING_SERVICE_INTERFACE_H_
7#include "zoom_sdk_def.h"
8#if defined(WIN32)
9#include "zoom_sdk_util_define.h"
10#endif
11
18{
19public:
24 virtual const zchar_t* GetDeviceId() = 0;
25
30 virtual const zchar_t* GetDeviceName() = 0;
31
36 virtual bool IsSelectedDevice() = 0;
37
38 virtual ~ICameraInfo() {};
39};
40
46{
47public:
52 virtual const zchar_t* GetDeviceId() = 0;
53
58 virtual const zchar_t* GetDeviceName() = 0;
59
64 virtual bool IsSelectedDevice() = 0;
65
66 virtual ~IMicInfo() {};
67};
68
74{
75public:
80 virtual const zchar_t* GetDeviceId() = 0;
81
86 virtual const zchar_t* GetDeviceName() = 0;
87
92 virtual bool IsSelectedDevice() = 0;
93
94 virtual ~ISpeakerInfo() {};
95};
96
102{
103public:
108 virtual const zchar_t* GetDeviceId() = 0;
109
114 virtual const zchar_t* GetDeviceName() = 0;
115
120 virtual bool IsSelectedDevice() = 0;
121
122 virtual ~IRingSpeakerInfo() {};
123};
124
147
148
149#if defined(WIN32)
153typedef enum tagReactionSkinToneType
154{
156 ReactionSkinTone_None = 0,
158 ReactionSkinTone_Default,
160 ReactionSkinTone_Light,
162 ReactionSkinTone_MediumLight,
164 ReactionSkinTone_Medium,
166 ReactionSkinTone_MediumDark,
168 ReactionSkinTone_Dark,
169}ReactionSkinToneType;
170
174enum ZoomSDKUITheme
175{
177 ZoomSDKUITheme_Bloom,
179 ZoomSDKUITheme_Rose,
181 ZoomSDKUITheme_Agave,
183 ZoomSDKUITheme_Classic,
184};
185
189enum ZoomSDKUIAppearance
190{
192 ZoomSDKUIAppearance_Light = 1,
194 ZoomSDKUIAppearance_Dark,
196 ZoomSDKUIAppearance_System,
197};
198
202enum WindowSizeType
203{
205 WindowSize_None = 0,
207 WindowSize_FullScreen,
209 WindowSize_Maximize,
211 WindowSize_CurrentSize,
212};
213
217enum SettingTabPage
218{
220 SettingTabPage_General,
222 SettingTabPage_Audio,
224 SettingTabPage_Video,
225};
226
230enum ScreenCaptureMode
231{
233 CaptureMode_auto = 0,
235 CaptureMode_legacy,
237 CaptureMode_gpu_copy_filter,
239 CaptureMode_ada_copy_filter,
241 CaptureMode_ada_copy_without_filter,
243 CaptureMode_ada_secure_filter,
245 CaptureMode_end,
246};
247
251enum ShareOptionInMeeting
252{
254 ShareOptionInMeeting_AllOption,
256 ShareOptionInMeeting_AutoShareDesktop,
257};
258
262enum ShareOptionToRoom
263{
265 ShareOptionToRoom_AllOption,
267 ShareOptionToRoom_AutoShareDesktop,
268};
269
273enum ShareSelectMode
274{
276 SelectMode_None = 0,
278 SelectMode_Window,
280 SelectMode_Process,
281};
282
286typedef struct tagShowSettingDlgParam
287{
289 HWND hParent;
291 int top;
293 int left;
295 HWND hSettingWnd;
297 bool bShow;
299 bool bCenter;
301 SettingTabPage eTabPageType;
302 tagShowSettingDlgParam()
303 {
304 hParent = nullptr;
305 top = 0;
306 left = 0;
307 hSettingWnd = nullptr;
308 bShow = true;
309 bCenter = false;
310 eTabPageType = SettingTabPage_General;
311 }
312}ShowSettingDlgParam;
313
317typedef struct tagSettingDlgShowTabPageOption
318{
320 bool bShowGeneral;
322 bool bShowVideo;
324 bool bShowAudio;
326 bool bShowShareScreen;
328 bool bShowVirtualBackGround;
330 bool bSHowRecording;
332 bool bShowAdvancedFeature;
334 bool bShowStatistics;
336 bool bShowFeedback;
338 bool bShowKeyboardShortcuts;
340 bool bShowAccessibility;
341 tagSettingDlgShowTabPageOption()
342 {
343 bShowGeneral = true;
344 bShowVideo = true;
345 bShowAudio = true;
346 bShowShareScreen = true;
347 bShowVirtualBackGround = true;
348 bSHowRecording = true;
349 bShowStatistics = true;
350 bShowAccessibility = true;
351 bShowKeyboardShortcuts = true;
352 bShowAdvancedFeature = false;
353 bShowFeedback = false;
354 }
355
356}SettingDlgShowTabPageOption;
357
361typedef struct tagSettingDlgShowUrlOption
362{
364 bool bShowGeneralViewMoreSetting;
366 bool bShowVideoSupportCenter;
368 bool bShowAudioLearnMore;
370 bool bShowShareAndVBLearnMore;
371 tagSettingDlgShowUrlOption()
372 {
373 bShowGeneralViewMoreSetting = true;
374 bShowVideoSupportCenter = true;
375 bShowAudioLearnMore = true;
376 bShowShareAndVBLearnMore = true;
377 }
378
379}SettingDlgShowUrlOption;
380
384typedef enum
385{
387 enuCanTest = 0,
389 enuMicRecording,
391 enuCanPlay,
392} SDK_TESTMIC_STATUS;
393
398class ITestAudioDeviceHelperEvent
399{
400public:
401 virtual ~ITestAudioDeviceHelperEvent() {}
402
408 virtual void OnMicSpkVolumeChanged(unsigned int MicVolume, unsigned int SpkVolume) = 0;
409
414 virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk) = 0;
415
422 virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,bool& bHandled) = 0;
423
427 virtual void OnSelectedAudioDeviceIsChanged() = 0;
428};
429
434class ITestAudioDeviceHelper
435{
436public:
443 virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;
444
451 virtual SDKError TestMicStartRecording(const zchar_t* deviceID = nullptr) = 0;
452
458 virtual SDKError TestMicStopTesting() = 0;
459
465 virtual SDKError TestMicPlayRecording() = 0;
466
473 virtual SDKError TestSpeakerStartPlaying(const zchar_t* deviceID = nullptr) = 0;
474
480 virtual SDKError TestSpeakerStopPlaying() = 0;
481
489 virtual SDKError SetTimerInterval(unsigned int timerInterval) = 0;
490};
491#endif
492
509
515{
516public:
522 virtual SDKError EnableAutoCopyInviteLink(bool bEnable) = 0;
523
528 virtual bool IsAutoCopyInviteLinkEnabled() = 0;
529
535 virtual SDKError EnableMuteWhenLockScreen(bool bEnable) = 0;
536
541 virtual bool IsMuteWhenLockScreenEnabled() = 0;
542#if defined(WIN32)
548 virtual SDKError EnableDualScreenMode(bool bEnable) = 0;
549
554 virtual bool IsDualScreenModeEnabled() = 0;
555
562 virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff) = 0;
563
568 virtual bool IsAeroModeInSharingTurnOff() = 0;
569
575 virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable) = 0;
576
581 virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled() = 0;
582
588 virtual SDKError EnableSplitScreenMode(bool bEnable) = 0;
589
594 virtual bool IsSplitScreenModeEnabled() = 0;
595
601 virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable) = 0;
602
607 virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
608
614 virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable) = 0;
615
620 virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;
621
627 virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone) = 0;
628
633 virtual ReactionSkinToneType GetReactionSkinTone() = 0;
634
639 virtual bool IsSupportSetUITheme() = 0;
640
646 virtual SDKError SetUITheme(ZoomSDKUITheme theme) = 0;
647
652 virtual ZoomSDKUITheme GetUITheme() = 0;
653
658 virtual bool IsSupportSetUIAppearance() = 0;
659
665 virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance) = 0;
666
671 virtual ZoomSDKUIAppearance GetUIAppearance() = 0;
672
673#endif
674};
675#if defined(WIN32)
679typedef enum
680{
682 PREVIEW_VIDEO_ROTATION_ACTION_0,
684 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
686 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
688 PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
689} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;
690
694typedef enum
695{
697 VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
699 VIDEO_HARDWARE_ENCODE_SENDING,
701 VIDEO_HARDWARE_ENCODE_PROCESSING,
702}VIDEO_HARDWARE_ENCODE_TYPE;
703
708class ITestVideoDeviceHelperEvent
709{
710public:
711 virtual ~ITestVideoDeviceHelperEvent() {}
712
716 virtual void OnNoVideoDeviceIsUseful() = 0;
717
721 virtual void OnSelectedVideoDeviceIsChanged() = 0;
722
726 virtual void OnNoWindowToShowPreview() = 0;
727};
728
733class ITestVideoDeviceHelper
734{
735public:
742 virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
743
751 virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
752
760 virtual SDKError TestVideoStartPreview(const zchar_t* deviceID = nullptr) = 0;
761
767 virtual SDKError TestVideoStopPreview() = 0;
768
775 virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action) = 0;
776
777 virtual ICameraController* GetTestCameraController() = 0;
778};
779
784class ILipSyncAvatarPreviewHelperEvent
785{
786public:
787 virtual ~ILipSyncAvatarPreviewHelperEvent() {}
788
792 virtual void OnNoWindowToShowLipsyncPreview() = 0;
793};
794
799class ILipSyncAvatarPreviewHelper
800{
801public:
808 virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent* pEvent) = 0;
809
817 virtual SDKError SetLipSyncAvatarPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
818
824 virtual SDKError StartLipSyncAvatarPreview() = 0;
825
831 virtual SDKError StopLipSyncAvatarPreview() = 0;
832
833 virtual ~ILipSyncAvatarPreviewHelper() {};
834};
835
840class I3DAvatarImageInfo
841{
842public:
847 virtual bool IsSelected() = 0;
848
853 virtual bool IsLastUsed() = 0;
854
859 virtual const zchar_t* GetImageFilePath() = 0;
860
865 virtual const zchar_t* GetImageName() = 0;
866
872 virtual int GetIndex() = 0;
873
874 virtual ~I3DAvatarImageInfo() {};
875};
876
877#endif
890
891
897{
898public:
900
905 virtual void onComputerCamDeviceChanged(IList<ICameraInfo*>* pNewCameraList) = 0;
906
912 virtual void onDefaultCamDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
913};
914
927
942
959
965{
966public:
972
978 virtual SDKError SelectCamera(const zchar_t* deviceId) = 0;
979
985 virtual SDKError EnableFaceBeautyEffect(bool bEnable) = 0;
986
991 virtual bool IsFaceBeautyEffectEnabled() = 0;
992
997 virtual unsigned int GetFaceBeautyStrengthValue() = 0;
998
1004 virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue) = 0;
1005
1013 virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue) = 0;
1014
1019 virtual bool IsLightAdaptionEnabled() = 0;
1020
1026
1031 virtual double GetLightAdaptionManualValue() = 0;
1032
1038 virtual SDKError EnableHDVideo(bool bEnable) = 0;
1039
1044 virtual bool IsHDVideoEnabled() = 0;
1045
1052
1058
1064 virtual SDKError EnableTemporalDeNoise(bool bEnable) = 0;
1065
1070 virtual bool IsTemporalDeNoiseEnabled() = 0;
1071
1077 virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable) = 0;
1078
1084
1091
1097
1105
1113
1118 virtual bool IsVideoAutoFramingEnabled() = 0;
1119
1126
1133
1141 virtual SDKError SetVideoAutoFramingRatio(float ratio) = 0;
1142
1149
1157
1163
1170 virtual SDKError EnableOptimizeVideoQuality(bool bEnable) = 0;
1171
1177
1183#if defined(WIN32)
1189 virtual SDKError EnableVideoMirrorEffect(bool bEnable) = 0;
1190
1195 virtual bool IsVideoMirrorEffectEnabled() = 0;
1196
1202 virtual SDKError EnableSpotlightSelf(bool bEnable) = 0;
1203
1208 virtual bool IsSpotlightSelfEnabled() = 0;
1209
1215 virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
1216
1221 virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
1222
1228 virtual SDKError Enable49VideoesInGallaryView(bool bEnable) = 0;
1229
1234 virtual bool Is49VideoesInGallaryViewEnabled() = 0;
1235
1241 virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable) = 0;
1242
1247 virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;
1248
1254 virtual SDKError EnableVideoPreviewDialog(bool bEnable) = 0;
1255
1260 virtual bool IsVideoPreviewDialogEnabled() = 0;
1261
1267 virtual SDKError EnableStopIncomingVideo(bool bEnable) = 0;
1268
1273 virtual bool IsStopIncomingVideoEnabled() = 0;
1274
1281 virtual SDKError EnableHideSelfView(bool bEnable) = 0;
1282
1289 virtual SDKError IsHideSelfViewEnabled(bool& bEnabled) = 0;
1290
1295 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1296#endif
1297};
1298
1304{
1305public:
1307
1312 virtual void onComputerMicDeviceChanged(IList<IMicInfo*>* pNewMicList) = 0;
1313
1318 virtual void onComputerSpeakerDeviceChanged(IList<ISpeakerInfo*>* pNewSpeakerList) = 0;
1319
1325 virtual void onDefaultMicDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1326
1332 virtual void onDefaultSpeakerDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1333};
1334
1347
1359
1365{
1366public:
1372
1379 virtual SDKError SelectMic(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1380
1386
1393 virtual SDKError SelectSpeaker(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1394
1400 virtual SDKError EnableAutoJoinAudio(bool bEnable) = 0;
1401
1406 virtual bool IsAutoJoinAudioEnabled() = 0;
1407
1413 virtual SDKError EnableAutoAdjustMic(bool bEnable) = 0;
1414
1419 virtual bool IsAutoAdjustMicEnabled() = 0;
1420
1427
1433
1439 virtual SDKError EnableSuppressAudioNotify(bool bEnable) = 0;
1440
1446
1452 virtual SDKError SetMicVol(FLOAT& value) = 0;
1453
1458 virtual SDKError GetMicVol(FLOAT& value) = 0;
1459
1465 virtual SDKError SetSpeakerVol(FLOAT& value) = 0;
1466
1471 virtual SDKError GetSpeakerVol(FLOAT& value) = 0;
1472
1480
1486
1493
1499
1506
1512
1519
1526 virtual SDKError DisableEchoCancellation(bool bDisable) = 0;
1527
1532 virtual bool IsEchoCancellationDisabled() = 0;
1533
1535
1536 virtual SDKError GetRingSpkVolume(FLOAT& fValue) = 0;
1537
1538 virtual SDKError SetRingSpkVolume(FLOAT fValue) = 0;
1539
1540 virtual SDKError SetRingSpkDevice(const zchar_t* spk_id) = 0;
1541
1543
1545
1551 virtual SDKError EnableMicOriginalInput(bool bEnable) = 0;
1552#if defined(WIN32)
1559 virtual SDKError EnableStereoAudio(bool bEnable) = 0;
1560
1565 virtual bool IsStereoAudioEnable() = 0;
1566
1571 virtual bool IsMicOriginalInputEnable() = 0;
1572
1578 virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable) = 0;
1579
1584 virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;
1585
1590 virtual ITestAudioDeviceHelper* GetTestAudioDeviceHelper() = 0;
1591
1597 virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable) = 0;
1598
1603 virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;
1604
1611 virtual SDKError EnableHighFidelityMusicMode(bool bEnable) = 0;
1612
1617 virtual bool IsHighFidelityMusicModeDisabled() = 0;
1618
1619 virtual SDKError EnableAlwaysUseSeparateRingSpk(bool bEnable) = 0;
1620
1621 virtual bool IsAlwaysUseSeparateRingSpk() = 0;
1622
1623 virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio() = 0;
1624#endif
1625};
1626
1632{
1633public:
1635
1642 virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage) = 0;
1643};
1644
1650{
1651public:
1657 virtual SDKError SetRecordingPath(const zchar_t* szPath) = 0;
1658
1663 virtual const zchar_t* GetRecordingPath() = 0;
1664
1671
1677
1684
1690
1696 virtual SDKError CanGetRecordingManagementURL(bool& bEnable) = 0;
1697
1703 virtual SDKError EnableMultiAudioStreamRecord(bool bEnable) = 0;
1704
1710
1716 virtual SDKError EnableAddTimestampWatermark(bool bEnable) = 0;
1717
1723
1730
1736
1743
1749
1756
1762#if defined(WIN32)
1768 virtual SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable) = 0;
1769
1774 virtual bool IsSelectRecordFileLocationAfterMeetingEnabled() = 0;
1775#endif
1776
1777};
1778
1797
1810
1829
1857
1892
1893
1929
1936
1944
1950{
1951public:
1957
1962 virtual const zchar_t* GetWallpaperID() = 0;
1963
1968 virtual const zchar_t* GetTitle() = 0;
1969
1974 virtual const zchar_t* GetThumbnailPath() = 0;
1975
1980 virtual const zchar_t* GetPath() = 0;
1981
1986 virtual int GetTransparency() = 0;
1987
1992 virtual void SetTransparency(int transparency) = 0;
1993
1999
2000 virtual ~IWallpaperItem() {};
2001};
2002
2008{
2009public:
2015
2022
2023#if defined(WIN32)
2028 virtual void onPersonalWallpaperChanged(IWallpaperItem* item) = 0;
2029
2035 virtual void onPersonalWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t* wallpaperId) = 0;
2036#endif
2037};
2038
2044{
2045public:
2053
2058 virtual bool IsMeetingWallpaperEnabled() = 0;
2059
2065
2072
2078
2085
2090 virtual IWallpaperItem* GetMeetingWallpaperItemByID(const zchar_t* wallpaperID) = 0;
2091
2092#if defined(WIN32)
2097 virtual bool IsPersonalWallpaperEnabled() = 0;
2098
2104 virtual IWallpaperItem* GetCurrentPersonalWallpaperItem() = 0;
2105
2111 virtual IList<IWallpaperItem* >* GetPersonalWallpaperList() = 0;
2112
2119 virtual SDKError SetPersonalWallpaper(IWallpaperItem* item) = 0;
2120
2126 virtual IWallpaperItem* GetPersonalWallpaperItemByID(const zchar_t* wallpaperID) = 0;
2127#endif
2128};
2129
2130#if defined(WIN32)
2135class IAccessibilitySettingContext
2136{
2137public:
2143 virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable) = 0;
2144
2150 virtual SDKError IsAlwaysShowMeetingControlsEnable(bool& bEnable) = 0;
2151};
2152
2157class ISettingUIStrategy
2158{
2159public:
2164 virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable) = 0;
2165
2171 virtual void DisableAccountSettingTabPage(bool bDisable) = 0;
2172
2177 virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;
2178
2183 virtual void HideAutoCopyInviteLinkCheckBox(bool bHide) = 0;
2184
2189 virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption) = 0;
2190};
2195class IVirtualBGImageInfo
2196{
2197public:
2202 virtual bool isSelected() = 0;
2203
2208 virtual bool isAllowDelete() = 0;
2213 virtual const zchar_t* GetImageFilePath() = 0;
2214
2219 virtual const zchar_t* GetImageName() = 0;
2220
2221 virtual ~IVirtualBGImageInfo() {};
2222};
2223
2224enum VBVideoError {
2225 VB_VideoError_None = 0,
2226 VB_VideoError_UnknownFormat,
2227 VB_VideoError_ResolutionHigh1080P,
2228 VB_VideoError_ResolutionHigh720P,
2229 VB_VideoError_ResolutionLow,
2230 VB_VideoError_PlayError,
2231 VB_VideoError_OpenError,
2232};
2233
2238class IVirtualBGSettingContextEvent
2239{
2240public:
2241 virtual ~IVirtualBGSettingContextEvent() {}
2242
2246 virtual void onVBImageDidDownloaded() = 0;
2247
2252 virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
2253
2257 virtual void onSelectedVBImageChanged() = 0;
2258
2263 virtual void OnVideoThumbReady(const zchar_t* file_path) = 0;
2264
2270 virtual void OnVideoThumbError(const zchar_t* file_path, VBVideoError error) = 0;
2271
2277 virtual void OnVideoPlayError(const zchar_t* file_path, VBVideoError error) = 0;
2278};
2279
2284class IVirtualBGSettingContext
2285{
2286public:
2293 virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent* pEvent) = 0;
2294
2299 virtual bool IsSupportVirtualBG() = 0;
2300
2305 virtual bool IsDeviceSupportSmartVirtualBG() = 0;
2306
2311 virtual bool IsSupportVirtualBackgroundVideo() = 0;
2312
2318 virtual bool IsDeviceSupportSmartVirtualBackgroundVideo() = 0;
2319
2325 virtual bool IsDeviceSupportGreenVirtualBackgroundVideo() = 0;
2326
2331 virtual bool IsUsingGreenScreenOn() = 0;
2332
2339 virtual SDKError SetUsingGreenScreen(bool bUse) = 0;
2340
2345 virtual bool IsAllowToAddNewVBItem() = 0;
2346
2352 virtual bool isAllowToRemoveVBItem() = 0;
2353
2359 virtual SDKError AddBGImage(const zchar_t* file_path) = 0;
2360
2366 virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
2367
2372 virtual IList<IVirtualBGImageInfo* >* GetBGImageList() = 0;
2373
2379 virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;
2380
2385 virtual DWORD GetBGReplaceColor() = 0;
2386
2391 virtual SDKError BeginSelectReplaceVBColor() = 0;
2392
2398 virtual SDKError AddBGVideo(const zchar_t* file_path) = 0;
2399
2405 virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
2406
2411 virtual IList<IVirtualBGImageInfo* >* GetBGVideoList() = 0;
2412
2418 virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;
2419
2424 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2425};
2426
2427typedef enum
2428{
2429 ZoomSDKVideoEffectType_None = 0,
2430 ZoomSDKVideoEffectType_Filter = 1,
2431 ZoomSDKVideoEffectType_Frame = 2,
2432 ZoomSDKVideoEffectType_CustomFilter = 3,
2433 ZoomSDKVideoEffectType_Sticker = 4,
2434}ZoomSDKVideoEffectType;
2435
2440class IVideoFilterImageInfo
2441{
2442public:
2447 virtual bool isSelected() = 0;
2448
2453 virtual const zchar_t* GetImageFilePath() = 0;
2454
2459 virtual const zchar_t* GetImageName() = 0;
2460
2466 virtual ZoomSDKVideoEffectType GetType() = 0;
2467
2473 virtual int GetIndex() = 0;
2474
2475 virtual ~IVideoFilterImageInfo() {};
2476};
2477
2482class IVideoFilterSettingContextEvent
2483{
2484public:
2488 virtual void onVideoFilterItemThumnailsDownloaded() = 0;
2489
2495 virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type, int index) = 0;
2496
2503 virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index) = 0;
2504};
2505
2510class IVideoFilterSettingContext
2511{
2512public:
2519 virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent* pEvent) = 0;
2520
2521
2526 virtual bool IsSupportVideoFilter() = 0;
2527
2532 virtual bool IsVideoFilterEnabled() = 0;
2533
2538 virtual bool IsVideoFilterLocked() = 0;
2539
2544 virtual IList<IVideoFilterImageInfo* >* GetVideoFilterImageList() = 0;
2545
2551 virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;
2552
2557 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2558};
2559
2564class I3DAvatarSettingContextEvent
2565{
2566public:
2567 virtual ~I3DAvatarSettingContextEvent() {}
2568
2572 virtual void on3DAvatarItemThumbnailsDownloaded() = 0;
2573
2578 virtual void on3DAvatarItemDataDownloading(int index) = 0;
2579
2585 virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index) = 0;
2586};
2587
2592class I3DAvatarSettingContext
2593{
2594public:
2601 virtual SDKError SetEvent(I3DAvatarSettingContextEvent* pEvent) = 0;
2602
2607 virtual bool Is3DAvatarSupportedByDevice() = 0;
2608
2613 virtual bool Is3DAvatarEnabled() = 0;
2614
2620 virtual SDKError Enable3DAvatarEffectForAllMeeting(bool bEnable) = 0;
2621
2626 virtual bool Is3DAvatarEffectForAllMeetingEnabled() = 0;
2627
2632 virtual IList<I3DAvatarImageInfo* >* Get3DAvatarImageList() = 0;
2633
2639 virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;
2640
2645 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2646
2652 virtual ILipSyncAvatarPreviewHelper* GetLipSyncAvatarPreviewHelper() = 0;
2653};
2654
2655typedef enum
2656{
2657 ZoomSDKFaceMakeupType_Mustache,
2658 ZoomSDKFaceMakeupType_Eyebrow,
2659 ZoomSDKFaceMakeupType_Lip
2660}ZoomSDKFaceMakeupType;
2661
2666class IFaceMakeupImageInfo
2667{
2668public:
2673 virtual ZoomSDKFaceMakeupType GetFaceMakeupType() = 0;
2674
2679 virtual bool IsSelected() = 0;
2680
2685 virtual const zchar_t* GetImageFilePath() = 0;
2686
2691 virtual const zchar_t* GetImageName() = 0;
2692
2698 virtual int GetIndex() = 0;
2699
2700 virtual ~IFaceMakeupImageInfo() {};
2701};
2702
2707class IFaceMakeupSettingContextEvent
2708{
2709public:
2710 virtual ~IFaceMakeupSettingContextEvent() {}
2711
2715 virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type) = 0;
2716
2721 virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type, int index) = 0;
2722
2728 virtual void onFaceMakeupItemDataDownloaded(bool bSuccess, ZoomSDKFaceMakeupType type, int index) = 0;
2729};
2730
2735class IFaceMakeupSettingContext
2736{
2737public:
2744 virtual SDKError SetEvent(IFaceMakeupSettingContextEvent* pEvent) = 0;
2745
2750 virtual bool IsFaceMakeupEnabled() = 0;
2751
2756 virtual bool IsSupportFaceMakeup() = 0;
2757
2763 virtual SDKError EnableFaceMakeupEffectForAllMeeting(bool bEnable) = 0;
2764
2769 virtual bool IsFaceMakeupEffectForAllMeetingEnabled() = 0;
2770
2775 virtual IList<IFaceMakeupImageInfo* >* GetFaceMakeupImageList() = 0;
2776
2782 virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo* pImage) = 0;
2783
2789 virtual SDKError SetLipsFaceMakeup(bool bEnable) = 0;
2790
2797 virtual SDKError SetColor(ZoomSDKFaceMakeupType type, unsigned long color) = 0;
2798
2805 virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type, unsigned int opactity) = 0;
2806
2811 virtual SDKError ResetAllFaceMakeupEffect() = 0;
2812
2817 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2818};
2819#endif
2820
2826{
2827public:
2828
2835
2841
2847 virtual SDKError EnableTCPConnectionWhenSharing(bool bEnable) = 0;
2848
2853 virtual bool IsTCPConnectionWhenSharing() = 0;
2854
2860
2866 virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable) = 0;
2867
2873 virtual SDKError IsAccelerateGPUWhenShareEnabled(bool& bEnable) = 0;
2874
2880 virtual SDKError EnableGreenBorderWhenShare(bool bEnable) = 0;
2881
2887
2892 virtual bool IsLimitFPSEnabledWhenShare() = 0;
2893
2899 virtual SDKError EnableLimitFPSWhenShare(bool bEnable) = 0;
2900
2905
2912
2918 virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable) = 0;
2919
2925
2931
2932
2937 virtual bool IsDoNotDisturbInSharingOn() = 0;
2938
2944 virtual SDKError EnableDoNotDisturbInSharing(bool bEnable) = 0;
2945
2952
2958 virtual SDKError IsAnnotationHardwareAccelerated(bool& bEnable) = 0;
2959
2966
2973#if defined(WIN32)
2979 virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType) = 0;
2980
2984 virtual WindowSizeType GetWindowSizeTypeWhenViewShare() = 0;
2985
2991 virtual SDKError EnableRemoteControlAllApplications(bool bEnable) = 0;
2992
2997 virtual bool IsRemoteControlAllApplicationsEnabled() = 0;
2998
3004 virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting& shareOption) = 0;
3005
3011 virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption) = 0;
3012
3018 virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode& select_mode) = 0;
3019
3025 virtual SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode) = 0;
3026
3032 virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom& share_option) = 0;
3033
3039 virtual SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option) = 0;
3040
3046 virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode) = 0;
3047
3053 virtual SDKError GetScreenCaptureMode(ScreenCaptureMode& capture_mode) = 0;
3054#endif
3055};
3056
3062{
3063public:
3064
3070
3076
3082
3088
3094
3100
3101#if defined(WIN32)
3108 virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;
3109
3115 virtual SDKError HideSettingDlg() = 0;
3116
3121 virtual IAccessibilitySettingContext* GetAccessibilitySettings() = 0;
3122
3127 virtual ISettingUIStrategy* GetSettingUIStrategy() = 0;
3128
3133 virtual IVirtualBGSettingContext* GetVirtualBGSettings() = 0;
3134
3139 virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;
3140
3145 virtual I3DAvatarSettingContext* Get3DAvatarSettings() = 0;
3146
3151 virtual IFaceMakeupSettingContext* GetFaceMakeupSettings() = 0;
3152#endif
3153
3159
3160};
3162#endif
Audio setting context callback event.
virtual void onComputerSpeakerDeviceChanged(IList< ISpeakerInfo * > *pNewSpeakerList)=0
Notification of the SDK detects that the computer speaker devices have been changed.
virtual void onDefaultMicDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notification of the user that a microphone device is selected.
virtual void onComputerMicDeviceChanged(IList< IMicInfo * > *pNewMicList)=0
Notification of the SDK detects that the computer mic devices have been changed.
virtual void onDefaultSpeakerDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notification of 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.
VIDEO_LIGHT_ADAPTION_TYPE
Enumeration of light adaption type.
Suppress_Background_Noise_Level
Enumeration of the level to suppress background noise. For more information, please visit https://sup...
@ Suppress_BGNoise_Level_Low
@ Suppress_BGNoise_Level_None
@ Suppress_BGNoise_Level_Medium
@ Suppress_BGNoise_Level_High
@ Suppress_BGNoise_Level_Auto
SettingConnectionType
Enumeration of the connection type.
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
@ SETTINGS_CONNECTION_TYPE_CLOUD
@ SETTINGS_CONNECTION_TYPE_DIRECT
struct tagOverallStatisticInfo OverallStatisticInfo
Overall statistic information.
@ ZoomSDKWallpaperSettingStatus_DownloadFail
@ ZoomSDKWallpaperSettingStatus_Downloading
@ ZoomSDKWallpaperSettingStatus_Downloaded
@ ZoomSDKWallpaperSettingStatus_None
struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
The audio status information.
SDK_AUDIO_DEVICE_RAW_MODE_TYPE
Enumeration of signal processing by Windows audio device drivers. For more information,...
@ SDK_AUDIO_DEVICE_RAW_MODE_OFF
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
SettingsNetWorkType
Enumeration of the network type.
LimitFPSValue
Enumeration of the values to limit fps.
SDK_ECHO_CANCELLATION_LEVEL
Enumeration for echo cancellation. For more information, please visit https://support....
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_HIGH
@ SDK_ECHO_CANCELLATION_LOW
AutoFramingMode
Enumeration of the auto framing modes in video.
@ AutoFramingMode_center_coordinates
@ AutoFramingMode_face_recognition
FaceRecognitionFailStrategy
Enumeration of the face recognition failure strategies.
@ FaceRecognitionFailStrategy_using_original_video
@ FaceRecognitionFailStrategy_none
@ FaceRecognitionFailStrategy_remain
@ FaceRecognitionFailStrategy_using_center_coordinates
@ ZoomSDKWallpaperLayoutMode_Fill
@ ZoomSDKWallpaperLayoutMode_None
@ ZoomSDKWallpaperLayoutMode_Fit
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
The video status information.
Auto framing parameters.
FaceRecognitionFailStrategy fail_Strategy
The video status information.
The audio status information.
Overall statistic information.
SettingConnectionType 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
Enumeration of common errors of SDK.