Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
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)
11#endif
12
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
45{
46public:
51 virtual const zchar_t* GetDeviceId() = 0;
52
57 virtual const zchar_t* GetDeviceName() = 0;
58
63 virtual bool IsSelectedDevice() = 0;
64
65 virtual ~IMicInfo() {};
66};
67
72{
73public:
78 virtual const zchar_t* GetDeviceId() = 0;
79
84 virtual const zchar_t* GetDeviceName() = 0;
85
90 virtual bool IsSelectedDevice() = 0;
91
92 virtual ~ISpeakerInfo() {};
93};
94
99{
100public:
105 virtual const zchar_t* GetDeviceId() = 0;
106
111 virtual const zchar_t* GetDeviceName() = 0;
112
117 virtual bool IsSelectedDevice() = 0;
118
119 virtual ~IRingSpeakerInfo() {};
120};
121
144
145
146#if defined(WIN32)
167
182
195
210
223
244
255
266
279
284{
288 int top;
290 int left;
294 bool bShow;
300 {
301 hParent = nullptr;
302 top = 0;
303 left = 0;
304 hSettingWnd = nullptr;
305 bShow = true;
306 bCenter = false;
308 }
310
354
377
390
395{
396public:
398
404 virtual void OnMicSpkVolumeChanged(unsigned int MicVolume, unsigned int SpkVolume) = 0;
405
410 virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk) = 0;
411
418 virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,bool& bHandled) = 0;
419
424};
425
430{
431public:
439
446 virtual SDKError TestMicStartRecording(const zchar_t* deviceID = nullptr) = 0;
447
454
461
468 virtual SDKError TestSpeakerStartPlaying(const zchar_t* deviceID = nullptr) = 0;
469
476
484 virtual SDKError SetTimerInterval(unsigned int timerInterval) = 0;
485};
486#endif
487
504
509{
510public:
516 virtual SDKError EnableAutoCopyInviteLink(bool bEnable) = 0;
517
522 virtual bool IsAutoCopyInviteLinkEnabled() = 0;
523
529 virtual SDKError EnableMuteWhenLockScreen(bool bEnable) = 0;
530
535 virtual bool IsMuteWhenLockScreenEnabled() = 0;
536#if defined(WIN32)
542 virtual SDKError EnableDualScreenMode(bool bEnable) = 0;
543
548 virtual bool IsDualScreenModeEnabled() = 0;
549
556 virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff) = 0;
557
562 virtual bool IsAeroModeInSharingTurnOff() = 0;
563
570
576
582 virtual SDKError EnableSplitScreenMode(bool bEnable) = 0;
583
588 virtual bool IsSplitScreenModeEnabled() = 0;
589
596
602
608 virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable) = 0;
609
615
622
628
633 virtual bool IsSupportSetUITheme() = 0;
634
641
647
652 virtual bool IsSupportSetUIAppearance() = 0;
653
660
666
667#endif
668};
669#if defined(WIN32)
684
697
702{
703public:
705
709 virtual void OnNoVideoDeviceIsUseful() = 0;
710
715
719 virtual void OnNoWindowToShowPreview() = 0;
720};
721
726{
727public:
735
743 virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
744
752 virtual SDKError TestVideoStartPreview(const zchar_t* deviceID = nullptr) = 0;
753
760
768
770};
771
785
825
830{
831public:
836 virtual bool IsSelected() = 0;
837
842 virtual bool IsLastUsed() = 0;
843
848 virtual const zchar_t* GetImageFilePath() = 0;
849
854 virtual const zchar_t* GetImageName() = 0;
855
861 virtual int GetIndex() = 0;
862
864};
865
866#endif
879
880
885{
886public:
888
893 virtual void onComputerCamDeviceChanged(IList<ICameraInfo*>* pNewCameraList) = 0;
894
900 virtual void onDefaultCamDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
901};
902
915
930
947
952{
953public:
959
965 virtual SDKError SelectCamera(const zchar_t* deviceId) = 0;
966
972 virtual SDKError EnableFaceBeautyEffect(bool bEnable) = 0;
973
978 virtual bool IsFaceBeautyEffectEnabled() = 0;
979
984 virtual unsigned int GetFaceBeautyStrengthValue() = 0;
985
991 virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue) = 0;
992
1000 virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue) = 0;
1001
1006 virtual bool IsLightAdaptionEnabled() = 0;
1007
1013
1018 virtual double GetLightAdaptionManualValue() = 0;
1019
1025 virtual SDKError EnableHDVideo(bool bEnable) = 0;
1026
1031 virtual bool IsHDVideoEnabled() = 0;
1032
1039
1045
1051 virtual SDKError EnableTemporalDeNoise(bool bEnable) = 0;
1052
1057 virtual bool IsTemporalDeNoiseEnabled() = 0;
1058
1064 virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable) = 0;
1065
1071
1078
1084
1092
1100
1105 virtual bool IsVideoAutoFramingEnabled() = 0;
1106
1113
1120
1128 virtual SDKError SetVideoAutoFramingRatio(float ratio) = 0;
1129
1136
1144
1150
1157 virtual SDKError EnableOptimizeVideoQuality(bool bEnable) = 0;
1158
1164
1170#if defined(WIN32)
1176 virtual SDKError EnableVideoMirrorEffect(bool bEnable) = 0;
1177
1182 virtual bool IsVideoMirrorEffectEnabled() = 0;
1183
1189 virtual SDKError EnableSpotlightSelf(bool bEnable) = 0;
1190
1195 virtual bool IsSpotlightSelfEnabled() = 0;
1196
1202 virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
1203
1209
1215 virtual SDKError Enable49VideoesInGallaryView(bool bEnable) = 0;
1216
1222
1229
1235
1241 virtual SDKError EnableVideoPreviewDialog(bool bEnable) = 0;
1242
1248
1254 virtual SDKError EnableStopIncomingVideo(bool bEnable) = 0;
1255
1260 virtual bool IsStopIncomingVideoEnabled() = 0;
1261
1268 virtual SDKError EnableHideSelfView(bool bEnable) = 0;
1269
1276 virtual SDKError IsHideSelfViewEnabled(bool& bEnabled) = 0;
1277
1283#endif
1284};
1285
1290{
1291public:
1293
1298 virtual void onComputerMicDeviceChanged(IList<IMicInfo*>* pNewMicList) = 0;
1299
1304 virtual void onComputerSpeakerDeviceChanged(IList<ISpeakerInfo*>* pNewSpeakerList) = 0;
1305
1311 virtual void onDefaultMicDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1312
1318 virtual void onDefaultSpeakerDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1319};
1320
1333
1343
1348{
1349public:
1355
1362 virtual SDKError SelectMic(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1363
1369
1376 virtual SDKError SelectSpeaker(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
1377
1383 virtual SDKError EnableAutoJoinAudio(bool bEnable) = 0;
1384
1389 virtual bool IsAutoJoinAudioEnabled() = 0;
1390
1396 virtual SDKError EnableAutoAdjustMic(bool bEnable) = 0;
1397
1402 virtual bool IsAutoAdjustMicEnabled() = 0;
1403
1410
1416
1422 virtual SDKError EnableSuppressAudioNotify(bool bEnable) = 0;
1423
1429
1435 virtual SDKError SetMicVol(FLOAT& value) = 0;
1436
1441 virtual SDKError GetMicVol(FLOAT& value) = 0;
1442
1448 virtual SDKError SetSpeakerVol(FLOAT& value) = 0;
1449
1454 virtual SDKError GetSpeakerVol(FLOAT& value) = 0;
1455
1463
1469
1476
1482
1489
1495
1502
1509 virtual SDKError DisableEchoCancellation(bool bDisable) = 0;
1510
1515 virtual bool IsEchoCancellationDisabled() = 0;
1516
1518
1519 virtual SDKError GetRingSpkVolume(FLOAT& fValue) = 0;
1520
1521 virtual SDKError SetRingSpkVolume(FLOAT fValue) = 0;
1522
1523 virtual SDKError SetRingSpkDevice(const zchar_t* spk_id) = 0;
1524
1526
1528
1534 virtual SDKError EnableMicOriginalInput(bool bEnable) = 0;
1535#if defined(WIN32)
1542 virtual SDKError EnableStereoAudio(bool bEnable) = 0;
1543
1548 virtual bool IsStereoAudioEnable() = 0;
1549
1554 virtual bool IsMicOriginalInputEnable() = 0;
1555
1561 virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable) = 0;
1562
1568
1574
1580 virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable) = 0;
1581
1587
1594 virtual SDKError EnableHighFidelityMusicMode(bool bEnable) = 0;
1595
1601
1602 virtual SDKError EnableAlwaysUseSeparateRingSpk(bool bEnable) = 0;
1603
1604 virtual bool IsAlwaysUseSeparateRingSpk() = 0;
1605
1607#endif
1608};
1609
1614{
1615public:
1617
1624 virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage) = 0;
1625};
1626
1631{
1632public:
1638 virtual SDKError SetRecordingPath(const zchar_t* szPath) = 0;
1639
1644 virtual const zchar_t* GetRecordingPath() = 0;
1645
1652
1658
1665
1671
1677 virtual SDKError CanGetRecordingManagementURL(bool& bEnable) = 0;
1678
1684 virtual SDKError EnableMultiAudioStreamRecord(bool bEnable) = 0;
1685
1691
1697 virtual SDKError EnableAddTimestampWatermark(bool bEnable) = 0;
1698
1704
1711
1717
1724
1730
1737
1743#if defined(WIN32)
1750
1756#endif
1757
1758};
1759
1778
1791
1810
1838
1873
1874
1909
1916
1924
1929{
1930public:
1936
1941 virtual const zchar_t* GetWallpaperID() = 0;
1942
1947 virtual const zchar_t* GetTitle() = 0;
1948
1953 virtual const zchar_t* GetThumbnailPath() = 0;
1954
1959 virtual const zchar_t* GetPath() = 0;
1960
1965 virtual int GetTransparency() = 0;
1966
1971 virtual void SetTransparency(int transparency) = 0;
1972
1978
1979 virtual ~IWallpaperItem() {};
1980};
1981
1986{
1987public:
1993
2000
2001#if defined(WIN32)
2007
2014#endif
2015};
2016
2021{
2022public:
2030
2035 virtual bool IsMeetingWallpaperEnabled() = 0;
2036
2042
2049
2055
2062
2067 virtual IWallpaperItem* GetMeetingWallpaperItemByID(const zchar_t* wallpaperID) = 0;
2068
2069#if defined(WIN32)
2074 virtual bool IsPersonalWallpaperEnabled() = 0;
2075
2082
2089
2097
2103 virtual IWallpaperItem* GetPersonalWallpaperItemByID(const zchar_t* wallpaperID) = 0;
2104#endif
2105};
2106
2107#if defined(WIN32)
2112{
2113public:
2120
2127};
2128
2133{
2134public:
2139 virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable) = 0;
2140
2146 virtual void DisableAccountSettingTabPage(bool bDisable) = 0;
2147
2153
2158 virtual void HideAutoCopyInviteLinkCheckBox(bool bHide) = 0;
2159
2165};
2170{
2171public:
2176 virtual bool isSelected() = 0;
2177
2182 virtual bool isAllowDelete() = 0;
2187 virtual const zchar_t* GetImageFilePath() = 0;
2188
2193 virtual const zchar_t* GetImageName() = 0;
2194
2196};
2197
2207
2212{
2213public:
2215
2219 virtual void onVBImageDidDownloaded() = 0;
2220
2225 virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
2226
2230 virtual void onSelectedVBImageChanged() = 0;
2231
2236 virtual void OnVideoThumbReady(const zchar_t* file_path) = 0;
2237
2243 virtual void OnVideoThumbError(const zchar_t* file_path, VBVideoError error) = 0;
2244
2250 virtual void OnVideoPlayError(const zchar_t* file_path, VBVideoError error) = 0;
2251};
2252
2257{
2258public:
2266
2271 virtual bool IsSupportVirtualBG() = 0;
2272
2278
2284
2291
2298
2303 virtual bool IsUsingGreenScreenOn() = 0;
2304
2311 virtual SDKError SetUsingGreenScreen(bool bUse) = 0;
2312
2317 virtual bool IsAllowToAddNewVBItem() = 0;
2318
2324 virtual bool isAllowToRemoveVBItem() = 0;
2325
2331 virtual SDKError AddBGImage(const zchar_t* file_path) = 0;
2332
2338 virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
2339
2345
2352
2357 virtual DWORD GetBGReplaceColor() = 0;
2358
2364
2370 virtual SDKError AddBGVideo(const zchar_t* file_path) = 0;
2371
2377 virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
2378
2384
2391
2397};
2398
2407
2412{
2413public:
2418 virtual bool isSelected() = 0;
2419
2424 virtual const zchar_t* GetImageFilePath() = 0;
2425
2430 virtual const zchar_t* GetImageName() = 0;
2431
2438
2444 virtual int GetIndex() = 0;
2445
2447};
2448
2453{
2454public:
2459
2466
2473 virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index) = 0;
2474};
2475
2528
2533{
2534public:
2536
2541
2546 virtual void on3DAvatarItemDataDownloading(int index) = 0;
2547
2553 virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index) = 0;
2554};
2555
2621
2628
2633{
2634public:
2640
2645 virtual bool IsSelected() = 0;
2646
2651 virtual const zchar_t* GetImageFilePath() = 0;
2652
2657 virtual const zchar_t* GetImageName() = 0;
2658
2664 virtual int GetIndex() = 0;
2665
2667};
2668
2673{
2674public:
2676
2681
2687
2693 virtual void onFaceMakeupItemDataDownloaded(bool bSuccess, ZoomSDKFaceMakeupType type, int index) = 0;
2694};
2695
2700{
2701public:
2709
2714 virtual bool IsFaceMakeupEnabled() = 0;
2715
2720 virtual bool IsSupportFaceMakeup() = 0;
2721
2728
2734
2740
2747
2753 virtual SDKError SetLipsFaceMakeup(bool bEnable) = 0;
2754
2761 virtual SDKError SetColor(ZoomSDKFaceMakeupType type, unsigned long color) = 0;
2762
2769 virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type, unsigned int opactity) = 0;
2770
2776
2782};
2783#endif
2784
2789{
2790public:
2791
2798
2804
2810 virtual SDKError EnableTCPConnectionWhenSharing(bool bEnable) = 0;
2811
2816 virtual bool IsTCPConnectionWhenSharing() = 0;
2817
2823
2829 virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable) = 0;
2830
2836 virtual SDKError IsAccelerateGPUWhenShareEnabled(bool& bEnable) = 0;
2837
2843 virtual SDKError EnableGreenBorderWhenShare(bool bEnable) = 0;
2844
2850
2855 virtual bool IsLimitFPSEnabledWhenShare() = 0;
2856
2862 virtual SDKError EnableLimitFPSWhenShare(bool bEnable) = 0;
2863
2868
2875
2881 virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable) = 0;
2882
2888
2894
2895
2900 virtual bool IsDoNotDisturbInSharingOn() = 0;
2901
2907 virtual SDKError EnableDoNotDisturbInSharing(bool bEnable) = 0;
2908
2915
2921 virtual SDKError IsAnnotationHardwareAccelerated(bool& bEnable) = 0;
2922
2929
2936#if defined(WIN32)
2943
2948
2955
2961
2968
2975
2982
2989
2996
3003
3010
3017#endif
3018};
3019
3124#endif
3D avatar image information interface.
virtual const zchar_t * GetImageName()=0
Get the name of the current image.
virtual bool IsLastUsed()=0
Determine if the current item is most recently used.
virtual const zchar_t * GetImageFilePath()=0
Get the file path of the current image.
virtual bool IsSelected()=0
Determine if the current image is being used.
virtual int GetIndex()=0
Get the index of the current image.
3D avatar context callback event.
virtual void on3DAvatarItemThumbnailsDownloaded()=0
Notification of all 3D avatar items' thumbnails have been downloaded.
virtual void on3DAvatarItemDataDownloading(int index)=0
Notification of the selected 3d avatar item is downloading.
virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index)=0
Notification of whether or not the selected 3d avatar item has been downloaded successfully.
3D avatar setting interface.
virtual IList< I3DAvatarImageInfo * > * Get3DAvatarImageList()=0
Get the list of the 3D avatar images.
virtual bool Is3DAvatarEffectForAllMeetingEnabled()=0
Determine if the selected 3D avatar effect is always used by the future meetings.
virtual bool Is3DAvatarSupportedByDevice()=0
Determine if the 3D avatar feature is supported by video device.
virtual SDKError Enable3DAvatarEffectForAllMeeting(bool bEnable)=0
Enable/Disable the selected 3D avatar effect always used by the future meeting.
virtual ILipSyncAvatarPreviewHelper * GetLipSyncAvatarPreviewHelper()=0
Get the pointer to ILipSyncAvatarPreviewHelper which is used to preview the lip-sync avatar.
virtual SDKError SetEvent(I3DAvatarSettingContextEvent *pEvent)=0
3D avatar callback handler.
virtual bool Is3DAvatarEnabled()=0
Determine if the 3D avatar feature is enabled.
virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo *pImage)=0
Specify an image to be the the 3D avatar image.
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with 3D avatar image.
Accessibility setting interface.
virtual SDKError IsAlwaysShowMeetingControlsEnable(bool &bEnable)=0
get the current setting status of Always Show Meeting Controls in meeting window.
virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable)=0
Enable/Disable Always Show Meeting Controls in meeting window.
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 ITestAudioDeviceHelper * GetTestAudioDeviceHelper()=0
Get the pointer to ITestAudioDeviceHelper which is used to test audio devices.
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 bool IsStereoAudioEnable()=0
Get the flag to enable/disable the stereo audio.
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 bool IsAlwaysUseSeparateRingSpk()=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 bool IsHighFidelityMusicModeDisabled()=0
Check whether the high fidelity music mode is enabled or not.
virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable)=0
Enable or disable to press and hold the Space-bar to speak when muted.
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 bool IsMicOriginalInputEnable()=0
Get the flag to enable/disable the original input of mic.
virtual SDKError SetMicVol(FLOAT &value)=0
Set the volume of the selected mic.
virtual SDKError SetRingSpkDevice(const zchar_t *spk_id)=0
virtual SDKError EnableAlwaysUseSeparateRingSpk(bool bEnable)=0
virtual SDKError EnableStereoAudio(bool bEnable)=0
Enable or disable the stereo audio.
virtual SDKError EnableAutoJoinAudio(bool bEnable)=0
Enable or disable the audio automatically when join meeting.
virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio()=0
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 bool IsSyncButtonsOnHeadsetEnabled()=0
Check whether the sync buttons on headset is enabled or not.
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 SDKError EnableSyncButtonsOnHeadset(bool bEnable)=0
Set whether to enable the function of sync buttons on headset or not.
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 bool IsHoldSpaceKeyToSpeakEnabled()=0
Get the flag to enable/disable to press and hold the Space-bar to speak.
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 EnableHighFidelityMusicMode(bool bEnable)=0
Set whether to enable the function of high fidelity music mode or not.
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.
face makeup image information interface.
virtual ZoomSDKFaceMakeupType GetFaceMakeupType()=0
Get the type of current image.
virtual const zchar_t * GetImageFilePath()=0
Get the file path of the current image.
virtual bool IsSelected()=0
Determine if the current item is being used.
virtual const zchar_t * GetImageName()=0
Get the name of the current image.
virtual int GetIndex()=0
Get the index of the current face makeup.
Face makeup context callback event.
virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type)=0
Notification of all face makeup items' thumbnails were downloaded.
virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type, int index)=0
Notification of the selected face makeup item is downloading.
virtual void onFaceMakeupItemDataDownloaded(bool bSuccess, ZoomSDKFaceMakeupType type, int index)=0
Notification of whether or not the selected face makeup item has downloaded successfully.
face makeup setting interface.
virtual bool IsSupportFaceMakeup()=0
Determine if the meeting supports the the face makeup feature.
virtual SDKError SetLipsFaceMakeup(bool bEnable)=0
Enable/Disable the lip face makeup effect.
virtual SDKError ResetAllFaceMakeupEffect()=0
Disable all the face makeup effect and reset color/opactity value to default value.
virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type, unsigned int opactity)=0
Set the transparency of face makeup effect.
virtual SDKError SetEvent(IFaceMakeupSettingContextEvent *pEvent)=0
face makeup callback handler.
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with face makeup image.
virtual bool IsFaceMakeupEffectForAllMeetingEnabled()=0
Determine if the selected face makeup effect is always used by future meetings.
virtual SDKError SetColor(ZoomSDKFaceMakeupType type, unsigned long color)=0
Set the colors of face makeup effect.
virtual SDKError EnableFaceMakeupEffectForAllMeeting(bool bEnable)=0
Enable/Disable the selected face makeup effect always used by the future meeting.
virtual bool IsFaceMakeupEnabled()=0
Determine if the face makeup feature is enabled.
virtual IList< IFaceMakeupImageInfo * > * GetFaceMakeupImageList()=0
Get the list of the face makeup images.
virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo *pImage)=0
Specify an image to be face makeup image.
General setting interface.
virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable)=0
Enable/Disable to show the elapsed time of the meeting.
virtual SDKError SetUITheme(ZoomSDKUITheme theme)=0
Set the UI skin theme type.
virtual SDKError EnableDualScreenMode(bool bEnable)=0
Enable or disable dual screen mode.
virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone)=0
Set the emoji reaction skin tone type.
virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled()=0
Determine if it is able to enter the full screen video mode automatically when join meeting.
virtual bool IsSplitScreenModeEnabled()=0
Determine if the split screen mode is enabled.
virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff)=0
Enable or disable the aero mode when sharing the screen.
virtual SDKError EnableAutoCopyInviteLink(bool bEnable)=0
Enable or disable to copy invite url automatically when meeting starts.
virtual ReactionSkinToneType GetReactionSkinTone()=0
Get the emoji reaction skin tone type.
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 IsDualScreenModeEnabled()=0
Determine if the dual screen mode is supported.
virtual bool IsAutoCopyInviteLinkEnabled()=0
Determine if it is able to automatically copy invite url when meeting starts is enabled.
virtual bool IsAeroModeInSharingTurnOff()=0
Determine if the aero mode is turned off when sharing the screen.
virtual SDKError EnableSplitScreenMode(bool bEnable)=0
Enable or disable to use the split screen mode, which enables the attendees to view the lectures or t...
virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance)=0
Set the UI appearance type.
virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable)=0
Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-...
virtual bool IsDisplayReminderWindowWhenExitEnabled()=0
Determine if reminder window is enabled when user exits the meeting.
virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable)=0
Enable or disable to enter the full screen video mode automatically when join meeting.
virtual ZoomSDKUIAppearance GetUIAppearance()=0
Get the UI appearance type.
virtual ZoomSDKUITheme GetUITheme()=0
Get the UI skin theme type.
virtual bool IsSupportSetUIAppearance()=0
Determine if support set UI appearance.
virtual bool IsSupportSetUITheme()=0
Determine if support set UI theme.
virtual bool IsShowMyMeetingElapseTimeEnabled()=0
Determine if showing elapsed time of the meeting 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.
lip-sync avatar callback event.
virtual void OnNoWindowToShowLipsyncPreview()=0
Notification of there is no window handle or a wrong window handle is used.
lip-sync avatar preview helper interface.
virtual SDKError StartLipSyncAvatarPreview()=0
Start to preview lip sync avatar.
virtual SDKError SetLipSyncAvatarPreviewParentWnd(HWND hParentWnd, RECT rc=_SDK_TEST_VIDEO_INIT_RECT)=0
Set the window and the rectangle to display the lip sync avatar preview.
virtual SDKError StopLipSyncAvatarPreview()=0
Stop to preview lip-sync avatar.
virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent *pEvent)=0
Video device test callback event handler.
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 IsSelectRecordFileLocationAfterMeetingEnabled()=0
Check if the function of selecting storage path for recording file is enabled.
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 SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable)=0
Set whether to enable the function of selecting the path to save the recording file after meeting.
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 IFaceMakeupSettingContext * GetFaceMakeupSettings()=0
Get face makeup settings interface.
virtual IVirtualBGSettingContext * GetVirtualBGSettings()=0
Get virtual background interface.
virtual IStatisticSettingContext * GetStatisticSettings()=0
Get statistic settings interface.
virtual IAccessibilitySettingContext * GetAccessibilitySettings()=0
Get Accessibility settings interface.
virtual I3DAvatarSettingContext * Get3DAvatarSettings()=0
Get 3D avatar settings interface.
virtual IRecordingSettingContext * GetRecordingSettings()=0
Get recording setting interface.
virtual SDKError HideSettingDlg()=0
Hide meeting setting dialog.
virtual ISettingUIStrategy * GetSettingUIStrategy()=0
Get setting user strategy interface.
virtual IShareSettingContext * GetShareSettings()=0
Get share settings interface.
virtual SDKError ShowSettingDlg(ShowSettingDlgParam &param)=0
Display Meeting Setting dialog.
virtual IGeneralSettingContext * GetGeneralSettings()=0
Get general setting interface.
virtual IVideoFilterSettingContext * GetVideoFilterSettings()=0
Get video filter settings 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.
Setting user strategy interface.
virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption)=0
Custom the tab page show or hide.
virtual void HideAutoCopyInviteLinkCheckBox(bool bHide)=0
Set the visibility of the AUTOMATICALLY COPY INVITE URL check-box on the General Setting page.
virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable)=0
Hide the link to check the advanced settings on the General Setting page or not.
virtual void DisableAccountSettingTabPage(bool bDisable)=0
Hide the Account Setting page or not.
virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption)=0
Custom the url link show or hide.
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 SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode)=0
Set the share select mode.
virtual bool IsAutoFitToWindowWhenViewSharingEnabled()=0
Determine if it is able to auto-fit the ZOOM window when viewing the shared content.
virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType)=0
Set the window size type when viewing the sharing.
virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting &shareOption)=0
Get the share option in meeting.
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 EnableRemoteControlAllApplications(bool bEnable)=0
Enable/disable remote control of all applications.
virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode &select_mode)=0
Get the share select mode.
virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom &share_option)=0
Get the share option to room.
virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable)=0
Enable/Disable to show the userself's app window when shares.
virtual SDKError GetScreenCaptureMode(ScreenCaptureMode &capture_mode)=0
Get the screen capture mode.
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 WindowSizeType GetWindowSizeTypeWhenViewShare()=0
Get the window size type when view share.
virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption)=0
Set the share option in meeting.
virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode)=0
set the screen capture mode.
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 SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option)=0
Get the share option to room.
virtual bool IsRemoteControlAllApplicationsEnabled()=0
Determine if remote control of all applications is enabled.
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.
Audio device testing callback events.
virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk)=0
Notify that either mic device or speaker device is not found.
virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status, bool &bHandled)=0
Notify the mic status when testing.
virtual void OnMicSpkVolumeChanged(unsigned int MicVolume, unsigned int SpkVolume)=0
Notify the current mic or speaker volume when testing.
virtual void OnSelectedAudioDeviceIsChanged()=0
Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/s...
Audio device test interface.
virtual SDKError TestMicStopTesting()=0
Stop the mic test. The SDK will return an error if there is no mic test.
virtual SDKError TestSpeakerStartPlaying(const zchar_t *deviceID=nullptr)=0
Start to test the speaker.
virtual SDKError SetEvent(ITestAudioDeviceHelperEvent *pEvent)=0
Audio device test callback handler.
virtual SDKError TestSpeakerStopPlaying()=0
Stop the speaker test. The SDK will return an error if there is no speaker test.
virtual SDKError TestMicStartRecording(const zchar_t *deviceID=nullptr)=0
Start to test the mic.
virtual SDKError TestMicPlayRecording()=0
Play the mic recorded sound. If there is no mic testing, SDK return an error.
virtual SDKError SetTimerInterval(unsigned int timerInterval)=0
Set the time interval for audio test.
Video Device test callback event.
virtual void OnSelectedVideoDeviceIsChanged()=0
Notification of a camera device is selected during the test, then the SDK will close the video testin...
virtual void OnNoWindowToShowPreview()=0
Notification of there is no window handle or a wrong window handle is used.
virtual void OnNoVideoDeviceIsUseful()=0
Notification of no camera device is found.
Video device test interface.
virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action)=0
Rotate the video preview.
virtual SDKError TestVideoStartPreview(const zchar_t *deviceID=nullptr)=0
Start to test the camera.
virtual SDKError SetEvent(ITestVideoDeviceHelperEvent *pEvent)=0
Video device test callback event handler.
virtual SDKError TestVideoStopPreview()=0
Stop testing the camera.
virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc=_SDK_TEST_VIDEO_INIT_RECT)=0
Set the window and the rectangle to display the video preview.
virtual ICameraController * GetTestCameraController()=0
Video filter image information interface.
virtual const zchar_t * GetImageName()=0
Get the name of current image.
virtual const zchar_t * GetImageFilePath()=0
Get the file path of current image.
virtual ZoomSDKVideoEffectType GetType()=0
Get the type of current image.
virtual int GetIndex()=0
Get the index of current image.
virtual bool isSelected()=0
Determine the usage of current image.
Video filter context Callback Event.
virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type, int index)=0
Notification of the selected video filter item is downloading.
virtual void onVideoFilterItemThumnailsDownloaded()=0
Notification of the thumbnails of all video filter items have been downloaded.
virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index)=0
Notification of the selected video filter item whether has been downloaded successfully.
Video filter setting interface.
virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo *pImage)=0
Specify an image to be the video filter image.
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background ...
virtual bool IsSupportVideoFilter()=0
Determine if the video filter feature is supported by the meeting.
virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent *pEvent)=0
Video filter callback handler.
virtual IList< IVideoFilterImageInfo * > * GetVideoFilterImageList()=0
Get the list of the video filter images.
virtual bool IsVideoFilterEnabled()=0
Determine if the video filter feature is enabled.
virtual bool IsVideoFilterLocked()=0
Determine if the video filter feature is locked.
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 EnableVideoPreviewDialog(bool bEnable)=0
Enable or disable to show the video preview dialog when join meeting.
virtual SDKError EnableHideSelfView(bool bEnable)=0
Enables or disables hiding the user's self view.
virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
Enable or disable the hardware acceleration.
virtual bool IsVideoPreviewDialogEnabled()=0
Get the flag to enable to show the video preview dialog when join meeting.
virtual bool Is49VideoesInGallaryViewEnabled()=0
Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.
virtual SDKError GetVideoAutoFramingMode(AutoFramingMode &mode)=0
Get current mode of auto-framing.
virtual SDKError Enable49VideoesInGallaryView(bool bEnable)=0
Enable or disable to show the participants in Gallery View up to 49 per screen.
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 bool IsStopIncomingVideoEnabled()=0
Get the flag to enable/disable to stop in coming video.
virtual unsigned int GetFaceBeautyStrengthValue()=0
Get the video facial beauty strength value.
virtual bool IsVideoMirrorEffectEnabled()=0
Checks whether the video mirror effect is enabled.
virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable)=0
Enable or disable to hide the non-video participants.
virtual bool IsHideNoVideoUsersOnWallViewEnabled()=0
Get the flag to enable/disable to hide non-video participants.
virtual bool IsVideoAutoFramingEnabled()=0
Determine whether auto-framing is enabled.
virtual bool IsOptimizeVideoQualitySupported()=0
Determine if optimizing received video quality is supported.
virtual SDKError IsHideSelfViewEnabled(bool &bEnabled)=0
Get the flag to enable/disable to hide user self's view.
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 IsSpotlightSelfEnabled()=0
Get the flag to enable/disable to spotlight 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 ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to test camera device.
virtual SDKError EnableVideoMirrorEffect(bool bEnable)=0
Enable or disable video mirror effect.
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 IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
Get the flag to enable/disable the hardware acceleration.
virtual bool IsHDVideoEnabled()=0
Get the flag to enable/disable the HD video.
virtual SDKError EnableSpotlightSelf(bool bEnable)=0
Enable or disable to spotlight the 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.
virtual SDKError EnableStopIncomingVideo(bool bEnable)=0
Enable or disable to stop incoming video.
Virtual background image information interface.
virtual bool isSelected()=0
Determine the usage of current image.
virtual const zchar_t * GetImageFilePath()=0
Get the file path of current image.
virtual const zchar_t * GetImageName()=0
Get the name of current image.
virtual bool isAllowDelete()=0
Determine the current image can be deleted from the list.
Virtual background context Callback Event.
virtual void onVBImageDidDownloaded()=0
Notification of the default virtual background images supplied by ZOOM are downloaded.
virtual void OnVideoThumbReady(const zchar_t *file_path)=0
Notification of creating the thumb of a virtual background video is success.
virtual void onSelectedVBImageChanged()=0
Notification of the virtual background image is changed.
virtual void OnVideoPlayError(const zchar_t *file_path, VBVideoError error)=0
Notification of playing a virtual background video is failed.
virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor)=0
Notification of the virtual background effect is updated with the selected color.
virtual void OnVideoThumbError(const zchar_t *file_path, VBVideoError error)=0
Notification of creating the thumb of a virtual background video is failed.
Virtual background setting interface.
virtual DWORD GetBGReplaceColor()=0
Get the selected color after called BeginSelectReplaceVBColor() and selected a color.
virtual bool IsDeviceSupportGreenVirtualBackgroundVideo()=0
Determine if the green virtual background video feature can be supported by the machine.
virtual SDKError RemoveBGVideo(IVirtualBGImageInfo *pRemoveVideo)=0
Remove a video from the virtual background video list.
virtual SDKError UseBGVideo(IVirtualBGImageInfo *pImage)=0
Specify a video to be the virtual background video.
virtual bool IsDeviceSupportSmartVirtualBackgroundVideo()=0
Determine if the smart virtual background video feature can be supported by the machine.
virtual SDKError AddBGImage(const zchar_t *file_path)=0
Add a new image as the virtual background image and to the image list.
virtual IList< IVirtualBGImageInfo * > * GetBGVideoList()=0
Get the list of the virtual background videoes.
virtual bool IsSupportVirtualBG()=0
Determine if the virtual background feature is supported by the meeting.
virtual SDKError AddBGVideo(const zchar_t *file_path)=0
Add a new video as the virtual background video and to the video list.
virtual ITestVideoDeviceHelper * GetTestVideoDeviceHelper()=0
Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background ...
virtual bool IsAllowToAddNewVBItem()=0
Determine if the adding new virtual background item feature is supported by the meeting.
virtual SDKError SetUsingGreenScreen(bool bUse)=0
Set to use the green screen for the virtual background feature.
virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent *pEvent)=0
Virtual background callback handler.
virtual bool isAllowToRemoveVBItem()=0
Determine if the removing virtual background item feature is supported by the meeting.
virtual SDKError BeginSelectReplaceVBColor()=0
Start to capture a color from video preview.
virtual bool IsSupportVirtualBackgroundVideo()=0
Determine if the video virtual background feature is supported by the meeting.
virtual bool IsUsingGreenScreenOn()=0
Determine if the green screen is using for the virtual background feature in the meeting.
virtual bool IsDeviceSupportSmartVirtualBG()=0
Determine if the smart virtual background feature can be supported by the machine.
virtual SDKError RemoveBGImage(IVirtualBGImageInfo *pRemoveImage)=0
Remove an image from the virtual background image list.
virtual SDKError UseBGImage(IVirtualBGImageInfo *pImage)=0
Specify an image to be the virtual background image.
virtual IList< IVirtualBGImageInfo * > * GetBGImageList()=0
Get the list of the virtual background images.
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 onPersonalWallpaperChanged(IWallpaperItem *item)=0
Callback event of notification that the personal wall-paper item is changed.
virtual void onPersonalWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t *wallpaperId)=0
Callback event of notification that download status of the personal wall-paper is changed.
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 IsPersonalWallpaperEnabled()=0
Determine if the personal wall-paper feature enabled by OP.
virtual IWallpaperItem * GetPersonalWallpaperItemByID(const zchar_t *wallpaperID)=0
Get the personal wall-paper item by wall-paper ID.
virtual bool IsMeetingWallpaperEnabled()=0
Determine if the meeting wall-paper feature enabled by OP.
virtual IList< IWallpaperItem * > * GetPersonalWallpaperList()=0
Get the current user's personal wall-paper list.
virtual bool IsMeetingWallpaperThumbsReady()=0
Determine if meeting wall-paper thumbnail ready.
virtual IList< IWallpaperItem * > * GetMeetingWallpaperList()=0
Get the meeting wall-paper list.
virtual SDKError SetPersonalWallpaper(IWallpaperItem *item)=0
Set the current user's personal wall-paper.
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.
virtual IWallpaperItem * GetCurrentPersonalWallpaperItem()=0
Get the current user's persional wall-paper item.
ScreenCaptureMode
Enumeration of the mode for screen capture. For more information, please visit https://support....
@ CaptureMode_gpu_copy_filter
@ CaptureMode_ada_secure_filter
@ CaptureMode_ada_copy_filter
@ CaptureMode_ada_copy_without_filter
PREVIEW_VIDEO_ROTATION_ACTION
Enumeration of rotation the video preview based on the current view.
@ PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180
@ PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90
@ PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
@ PREVIEW_VIDEO_ROTATION_ACTION_0
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
VIDEO_HARDWARE_ENCODE_TYPE
Enumeration of hardware acceleration. For more information, please visit https://support....
@ VIDEO_HARDWARE_ENCODE_PROCESSING
@ VIDEO_HARDWARE_ENCODE_SENDING
@ VIDEO_HARDWARE_ENCODE_RECEIVING
ZoomSDKUIAppearance
Enumeration of the UI Appearance. For more information, please visit https://support....
@ ZoomSDKUIAppearance_Light
@ ZoomSDKUIAppearance_System
@ ZoomSDKUIAppearance_Dark
SettingConnectionType
Enumeration of the connection type.
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
@ SETTINGS_CONNECTION_TYPE_CLOUD
@ SETTINGS_CONNECTION_TYPE_DIRECT
@ ZoomSDKVideoEffectType_Frame
@ ZoomSDKVideoEffectType_None
@ ZoomSDKVideoEffectType_Filter
@ ZoomSDKVideoEffectType_CustomFilter
@ ZoomSDKVideoEffectType_Sticker
@ VB_VideoError_ResolutionLow
@ VB_VideoError_ResolutionHigh1080P
@ VB_VideoError_ResolutionHigh720P
@ VB_VideoError_UnknownFormat
struct tagShowSettingDlgParam ShowSettingDlgParam
The parameter to show the meeting setting dialog in Zoom UI.
@ ZoomSDKFaceMakeupType_Mustache
@ ZoomSDKFaceMakeupType_Eyebrow
@ ZoomSDKFaceMakeupType_Lip
struct tagOverallStatisticInfo OverallStatisticInfo
Overall statistic information.
WindowSizeType
Enumeration of the windows size when share.
@ 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
off
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
on
struct tagSettingDlgShowTabPageOption SettingDlgShowTabPageOption
Define the strategy to show the tab pages in the setting dialog.
tagReactionSkinToneType
Enumeration of the skin tone type. For more information, please visit https://support....
@ ReactionSkinTone_Medium
@ ReactionSkinTone_MediumDark
@ ReactionSkinTone_Default
@ ReactionSkinTone_MediumLight
SettingsNetWorkType
Enumeration of the network type.
LimitFPSValue
Enumeration of the values to limit fps.
SDK_TESTMIC_STATUS
Enumeration of the status of the mic when testing.
SDK_ECHO_CANCELLATION_LEVEL
Enumeration for echo cancellation. For more information, please visit https://support....
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_AGGRESSIVE
ShareOptionToRoom
Enumeration of screen sharing options when you share directly to a Zoom Room. For more information,...
@ ShareOptionToRoom_AllOption
@ ShareOptionToRoom_AutoShareDesktop
struct tagSettingDlgShowUrlOption SettingDlgShowUrlOption
Define the strategy to show the url in the setting dialog.
ShareOptionInMeeting
Enumeration of screen sharing options when setting the page share screen item. For more information,...
@ ShareOptionInMeeting_AutoShareDesktop
@ ShareOptionInMeeting_AllOption
ZoomSDKUITheme
Enumeration of the UI theme. For more information, please visit https://support.zoom....
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
ShareSelectMode
Enumeration of share select mode.
enum tagReactionSkinToneType ReactionSkinToneType
Enumeration of the skin tone type. For more information, please visit https://support....
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
The video status information.
SettingTabPage
Enumeration of the shown tab page at the top of the displayed setting dialog.
enum PREVIEW_VIDEO_ROTATION_ACTION * PPREVIEW_VIDEO_ROTATION_ACTION
Auto framing parameters.
FaceRecognitionFailStrategy fail_Strategy
The video status information.
The audio status information.
Overall statistic information.
SettingConnectionType connection_type_
Define the strategy to show the tab pages in the setting dialog.
Define the strategy to show the url in the setting dialog.
The parameter to show the meeting setting dialog in Zoom UI.
bool bShow
Enable to display or nor.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
const RECT _SDK_TEST_VIDEO_INIT_RECT
SDKError
Enumeration of common errors of SDK.