6#ifndef _SETTING_SERVICE_INTERFACE_H_
7#define _SETTING_SERVICE_INTERFACE_H_
10#include "zoom_sdk_util_define.h"
123typedef enum tagReactionSkinToneType
125 ReactionSkinTone_None = 0,
126 ReactionSkinTone_Default,
127 ReactionSkinTone_Light,
128 ReactionSkinTone_MediumLight,
129 ReactionSkinTone_Medium,
130 ReactionSkinTone_MediumDark,
131 ReactionSkinTone_Dark,
132}ReactionSkinToneType;
136 ZoomSDKUITheme_Bloom,
138 ZoomSDKUITheme_Agave,
139 ZoomSDKUITheme_Classic,
142enum ZoomSDKUIAppearance
144 ZoomSDKUIAppearance_Light = 1,
145 ZoomSDKUIAppearance_Dark,
146 ZoomSDKUIAppearance_System,
152 WindowSize_FullScreen,
154 WindowSize_CurrentSize
163 SettingTabPage_General,
164 SettingTabPage_Audio,
165 SettingTabPage_Video,
168enum ScreenCaptureMode
170 CaptureMode_auto = 0,
172 CaptureMode_gpu_copy_filter,
173 CaptureMode_ada_copy_filter,
174 CaptureMode_ada_copy_without_filter,
175 CaptureMode_ada_secure_filter,
179enum ShareOptionInMeeting
181 ShareOptionInMeeting_AllOption,
182 ShareOptionInMeeting_AutoShareDesktop,
185enum ShareOptionToRoom
187 ShareOptionToRoom_AllOption,
188 ShareOptionToRoom_AutoShareDesktop,
202typedef struct tagShowSettingDlgParam
210 SettingTabPage eTabPageType;
211 tagShowSettingDlgParam()
216 hSettingWnd =
nullptr;
219 eTabPageType = SettingTabPage_General;
227typedef struct tagSettingDlgShowTabPageOption
232 bool bShowShareScreen;
233 bool bShowVirtualBackGround;
235 bool bShowAdvancedFeature;
236 bool bShowStatistics;
238 bool bShowKeyboardShortcuts;
239 bool bShowAccessibility;
240 tagSettingDlgShowTabPageOption()
245 bShowShareScreen =
true;
246 bShowVirtualBackGround =
true;
247 bSHowRecording =
true;
248 bShowStatistics =
true;
249 bShowAccessibility =
true;
250 bShowKeyboardShortcuts =
true;
251 bShowAdvancedFeature =
false;
252 bShowFeedback =
false;
255}SettingDlgShowTabPageOption;
261typedef struct tagSettingDlgShowUrlOption
263 bool bShowGeneralViewMoreSetting;
264 bool bShowVideoSupportCenter;
265 bool bShowAudioLearnMore;
266 bool bShowShareAndVBLearnMore;
267 tagSettingDlgShowUrlOption()
269 bShowGeneralViewMoreSetting =
true;
270 bShowVideoSupportCenter =
true;
271 bShowAudioLearnMore =
true;
272 bShowShareAndVBLearnMore =
true;
275}SettingDlgShowUrlOption;
290class ITestAudioDeviceHelperEvent
293 virtual ~ITestAudioDeviceHelperEvent() {}
298 virtual void OnMicSpkVolumeChanged(
unsigned int MicVolume,
unsigned int SpkVolume) = 0;
302 virtual void OnNoAudioDeviceIsUseful(
bool bMicOrSpk) = 0;
309 virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,
bool& bHandled) = 0;
312 virtual void OnSelectedAudioDeviceIsChanged() = 0;
317class ITestAudioDeviceHelper
325 virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;
333 virtual SDKError TestMicStartRecording(
const zchar_t* deviceID =
nullptr) = 0;
339 virtual SDKError TestMicStopTesting() = 0;
345 virtual SDKError TestMicPlayRecording() = 0;
353 virtual SDKError TestSpeakerStartPlaying(
const zchar_t* deviceID =
nullptr) = 0;
359 virtual SDKError TestSpeakerStopPlaying() = 0;
367 virtual SDKError SetTimerInterval(
unsigned int timerInterval) = 0;
408 virtual SDKError EnableDualScreenMode(
bool bEnable) = 0;
412 virtual bool IsDualScreenModeEnabled() = 0;
419 virtual SDKError TurnOffAeroModeInSharing(
bool bTurnoff) = 0;
423 virtual bool IsAeroModeInSharingTurnOff() = 0;
429 virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(
bool bEnable) = 0;
433 virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled() = 0;
439 virtual SDKError EnableSplitScreenMode(
bool bEnable) = 0;
443 virtual bool IsSplitScreenModeEnabled() = 0;
449 virtual SDKError EnableDisplayReminderWindowWhenExit(
bool bEnable) = 0;
453 virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
459 virtual SDKError EnableShowMyMeetingElapseTime(
bool bEnable) = 0;
463 virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;
469 virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone) = 0;
473 virtual ReactionSkinToneType GetReactionSkinTone() = 0;
477 virtual bool IsSupportSetUITheme() = 0;
483 virtual SDKError SetUITheme(ZoomSDKUITheme theme) = 0;
487 virtual ZoomSDKUITheme GetUITheme() = 0;
491 virtual bool IsSupportSetUIAppearance() = 0;
497 virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance) = 0;
501 virtual ZoomSDKUIAppearance GetUIAppearance() = 0;
512 PREVIEW_VIDEO_ROTATION_ACTION_0,
513 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
514 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
515 PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
516} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;
520 VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
521 VIDEO_HARDWARE_ENCODE_SENDING,
522 VIDEO_HARDWARE_ENCODE_PROCESSING,
523}VIDEO_HARDWARE_ENCODE_TYPE;
527class ITestVideoDeviceHelperEvent
530 virtual ~ITestVideoDeviceHelperEvent() {}
533 virtual void OnNoVideoDeviceIsUseful() = 0;
536 virtual void OnSelectedVideoDeviceIsChanged() = 0;
539 virtual void OnNoWindowToShowPreview() = 0;
544class ITestVideoDeviceHelper
552 virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
560 virtual SDKError SetVideoPreviewParentWnd(
HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
568 virtual SDKError TestVideoStartPreview(
const zchar_t* deviceID =
nullptr) = 0;
574 virtual SDKError TestVideoStopPreview() = 0;
583 virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action) = 0;
585 virtual ICameraController* GetTestCameraController() = 0;
590class ILipSyncAvatarPreviewHelperEvent
593 virtual ~ILipSyncAvatarPreviewHelperEvent() {}
596 virtual void OnNoWindowToShowLipsyncPreview() = 0;
601class ILipSyncAvatarPreviewHelper
609 virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent* pEvent) = 0;
617 virtual SDKError SetLipSyncAvatarPreviewParentWnd(
HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
623 virtual SDKError StartLipSyncAvatarPreview() = 0;
629 virtual SDKError StopLipSyncAvatarPreview() = 0;
631 virtual ~ILipSyncAvatarPreviewHelper() {};
636class I3DAvatarImageInfo
641 virtual bool IsSelected() = 0;
645 virtual bool IsLastUsed() = 0;
650 virtual const zchar_t* GetImageFilePath() = 0;
655 virtual const zchar_t* GetImageName() = 0;
660 virtual int GetIndex() = 0;
662 virtual ~I3DAvatarImageInfo() {};
899 virtual SDKError EnableVideoMirrorEffect(
bool bEnable) = 0;
903 virtual bool IsVideoMirrorEffectEnabled() = 0;
909 virtual SDKError EnableSpotlightSelf(
bool bEnable) = 0;
913 virtual bool IsSpotlightSelfEnabled() = 0;
919 virtual SDKError EnableHardwareEncode(
bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
923 virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
929 virtual SDKError Enable49VideoesInGallaryView(
bool bEnable) = 0;
933 virtual bool Is49VideoesInGallaryViewEnabled() = 0;
939 virtual SDKError EnableHideNoVideoUsersOnWallView(
bool bEnable) = 0;
943 virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;
949 virtual SDKError EnableVideoPreviewDialog(
bool bEnable) = 0;
953 virtual bool IsVideoPreviewDialogEnabled() = 0;
959 virtual SDKError EnableStopIncomingVideo(
bool bEnable) = 0;
963 virtual bool IsStopIncomingVideoEnabled() = 0;
970 virtual SDKError EnableHideSelfView(
bool bEnable) = 0;
975 virtual SDKError IsHideSelfViewEnabled(
bool& bEnabled) = 0;
981 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1181 virtual SDKError EnableStereoAudio(
bool bEnable) = 0;
1185 virtual bool IsStereoAudioEnable() = 0;
1189 virtual bool IsMicOriginalInputEnable() = 0;
1195 virtual SDKError EnableHoldSpaceKeyToSpeak(
bool bEnable) = 0;
1199 virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;
1205 virtual ITestAudioDeviceHelper* GetTestAudioDeviceHelper() = 0;
1211 virtual SDKError EnableSyncButtonsOnHeadset(
bool bEnable) = 0;
1215 virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;
1222 virtual SDKError EnableHighFidelityMusicMode(
bool bEnable) = 0;
1226 virtual bool IsHighFidelityMusicModeDisabled() = 0;
1228 virtual SDKError EnableAlwaysUseSeparateRingSpk(
bool bEnable) = 0;
1230 virtual bool IsAlwaysUseSeparateRingSpk() = 0;
1232 virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio() = 0;
1344 virtual SDKError EnableSelectRecordFileLocationAfterMeeting(
bool bEnable) = 0;
1348 virtual bool IsSelectRecordFileLocationAfterMeetingEnabled() = 0;
1548 virtual void onPersonalWallpaperChanged(
IWallpaperItem* item) = 0;
1598 virtual bool IsPersonalWallpaperEnabled() = 0;
1628class IAccessibilitySettingContext
1635 virtual SDKError EnableAlwaysShowMeetingControls(
bool bEnable) = 0;
1640 virtual SDKError IsAlwaysShowMeetingControlsEnable(
bool& bEnable) = 0;
1645class ISettingUIStrategy
1650 virtual void DisableAdvancedFeatures4GeneralSetting(
bool bDisable) = 0;
1655 virtual void DisableAccountSettingTabPage(
bool bDisable) = 0;
1659 virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;
1663 virtual void HideAutoCopyInviteLinkCheckBox(
bool bHide) = 0;
1667 virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption) = 0;
1671class IVirtualBGImageInfo
1676 virtual bool isSelected() = 0;
1680 virtual bool isAllowDelete() = 0;
1684 virtual const zchar_t* GetImageFilePath() = 0;
1689 virtual const zchar_t* GetImageName() = 0;
1691 virtual ~IVirtualBGImageInfo() {};
1695 VB_VideoError_None = 0,
1696 VB_VideoError_UnknownFormat,
1697 VB_VideoError_ResolutionHigh1080P,
1698 VB_VideoError_ResolutionHigh720P,
1699 VB_VideoError_ResolutionLow,
1700 VB_VideoError_PlayError,
1701 VB_VideoError_OpenError,
1706class IVirtualBGSettingContextEvent
1709 virtual ~IVirtualBGSettingContextEvent() {}
1712 virtual void onVBImageDidDownloaded() = 0;
1716 virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
1719 virtual void onSelectedVBImageChanged() = 0;
1723 virtual void OnVideoThumbReady(
const zchar_t* file_path) = 0;
1728 virtual void OnVideoThumbError(
const zchar_t* file_path, VBVideoError error) = 0;
1733 virtual void OnVideoPlayError(
const zchar_t* file_path, VBVideoError error) = 0;
1737class IVirtualBGSettingContext
1745 virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent* pEvent) = 0;
1749 virtual bool IsSupportVirtualBG() = 0;
1753 virtual bool IsSupportSmartVirtualBG() = 0;
1757 virtual bool IsUsingGreenScreenOn() = 0;
1764 virtual SDKError SetUsingGreenScreen(
bool bUse) = 0;
1768 virtual bool IsAllowToAddNewVBItem() = 0;
1772 virtual bool isAllowToRemoveVBItem() = 0;
1784 virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
1795 virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;
1800 virtual DWORD GetBGReplaceColor() = 0;
1805 virtual SDKError BeginSelectReplaceVBColor() = 0;
1817 virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
1828 virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;
1834 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1840 ZoomSDKVideoEffectType_None = 0,
1841 ZoomSDKVideoEffectType_Filter = 1,
1842 ZoomSDKVideoEffectType_Frame = 2,
1843 ZoomSDKVideoEffectType_CustomFilter = 3,
1844 ZoomSDKVideoEffectType_Sticker = 4,
1845}ZoomSDKVideoEffectType;
1849class IVideoFilterImageInfo
1854 virtual bool isSelected() = 0;
1859 virtual const zchar_t* GetImageFilePath() = 0;
1864 virtual const zchar_t* GetImageName() = 0;
1869 virtual ZoomSDKVideoEffectType GetType() = 0;
1874 virtual int GetIndex() = 0;
1876 virtual ~IVideoFilterImageInfo() {};
1881class IVideoFilterSettingContextEvent
1885 virtual void onVideoFilterItemThumnailsDownloaded() = 0;
1890 virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type,
int index) = 0;
1896 virtual void onVideoFilterItemDataDownloaded(
bool bSuccess, ZoomSDKVideoEffectType type,
int index) = 0;
1900class IVideoFilterSettingContext
1908 virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent* pEvent) = 0;
1913 virtual bool IsSupportVideoFilter() = 0;
1917 virtual bool IsVideoFilterEnabled() = 0;
1921 virtual bool IsVideoFilterLocked() = 0;
1932 virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;
1938 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1943class I3DAvatarSettingContextEvent
1946 virtual ~I3DAvatarSettingContextEvent() {}
1949 virtual void on3DAvatarItemThumbnailsDownloaded() = 0;
1953 virtual void on3DAvatarItemDataDownloading(
int index) = 0;
1958 virtual void on3DAvatarItemDataDownloaded(
bool bSuccess,
int index) = 0;
1962class I3DAvatarSettingContext
1970 virtual SDKError SetEvent(I3DAvatarSettingContextEvent* pEvent) = 0;
1974 virtual bool Is3DAvatarSupportedByDevice() = 0;
1978 virtual bool Is3DAvatarEnabled() = 0;
1984 virtual SDKError Enable3DAvatarEffectForAllMeeting(
bool bEnable) = 0;
1988 virtual bool Is3DAvatarEffectForAllMeetingEnabled() = 0;
1999 virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;
2005 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2011 virtual ILipSyncAvatarPreviewHelper* GetLipSyncAvatarPreviewHelper() = 0;
2016 ZoomSDKFaceMakeupType_Mustache,
2017 ZoomSDKFaceMakeupType_Eyebrow,
2018 ZoomSDKFaceMakeupType_Lip
2019}ZoomSDKFaceMakeupType;
2023class IFaceMakeupImageInfo
2028 virtual ZoomSDKFaceMakeupType GetFaceMakeupType() = 0;
2032 virtual bool IsSelected() = 0;
2037 virtual const zchar_t* GetImageFilePath() = 0;
2042 virtual const zchar_t* GetImageName() = 0;
2047 virtual int GetIndex() = 0;
2049 virtual ~IFaceMakeupImageInfo() {};
2054class IFaceMakeupSettingContextEvent
2057 virtual ~IFaceMakeupSettingContextEvent() {}
2060 virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type) = 0;
2064 virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type,
int index) = 0;
2069 virtual void onFaceMakeupItemDataDownloaded(
bool bSuccess, ZoomSDKFaceMakeupType type,
int index) = 0;
2073class IFaceMakeupSettingContext
2081 virtual SDKError SetEvent(IFaceMakeupSettingContextEvent* pEvent) = 0;
2085 virtual bool IsFaceMakeupEnabled() = 0;
2089 virtual bool IsSupportFaceMakeup() = 0;
2095 virtual SDKError EnableFaceMakeupEffectForAllMeeting(
bool bEnable) = 0;
2099 virtual bool IsFaceMakeupEffectForAllMeetingEnabled() = 0;
2110 virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo* pImage) = 0;
2116 virtual SDKError SetLipsFaceMakeup(
bool bEnable) = 0;
2123 virtual SDKError SetColor(ZoomSDKFaceMakeupType type,
unsigned long color) = 0;
2130 virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type,
unsigned int opactity) = 0;
2135 virtual SDKError ResetAllFaceMakeupEffect() = 0;
2141 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2269 virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType) = 0;
2272 virtual WindowSizeType GetWindowSizeTypeWhenViewShare() = 0;
2278 virtual SDKError EnableRemoteControlAllApplications(
bool bEnable) = 0;
2282 virtual bool IsRemoteControlAllApplicationsEnabled() = 0;
2288 virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting& shareOption) = 0;
2294 virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption) = 0;
2300 virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode& select_mode) = 0;
2306 virtual SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode) = 0;
2312 virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom& share_option) = 0;
2318 virtual SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option) = 0;
2324 virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode) = 0;
2330 virtual SDKError GetScreenCaptureMode(ScreenCaptureMode& capture_mode) = 0;
2382 virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;
2388 virtual SDKError HideSettingDlg() = 0;
2394 virtual IAccessibilitySettingContext* GetAccessibilitySettings() = 0;
2400 virtual ISettingUIStrategy* GetSettingUIStrategy() = 0;
2406 virtual IVirtualBGSettingContext* GetVirtualBGSettings() = 0;
2412 virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;
2418 virtual I3DAvatarSettingContext* Get3DAvatarSettings() = 0;
2424 virtual IFaceMakeupSettingContext* GetFaceMakeupSettings() = 0;
Audio setting context callback event.
virtual void onComputerSpeakerDeviceChanged(IList< ISpeakerInfo * > *pNewSpeakerList)=0
Callback event if the SDK detects that the computer speaker devices have been changed.
virtual ~IAudioSettingContextEvent()
virtual void onDefaultMicDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notify the user that a microphone device is selected.
virtual void onComputerMicDeviceChanged(IList< IMicInfo * > *pNewMicList)=0
Callback event if the SDK detects that the computer mic devices have been changed.
virtual void onDefaultSpeakerDeviceChanged(const zchar_t *deviceId, const zchar_t *deviceName)=0
Notify the user that a speaker device is selected.
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.
virtual ~IRecordingSettingContextEvent()
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 ~IRingSpeakerInfo()
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.
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.
virtual ~IVideoSettingContextEvent()
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 ¶m)=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 ¶m)=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 ~IWallpaperItem()
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
Suppress_Background_Noise_Level
@ Suppress_BGNoise_Level_Low
@ Suppress_BGNoise_Level_None
@ Suppress_BGNoise_Level_Medium
@ Suppress_BGNoise_Level_High
@ Suppress_BGNoise_Level_Auto
SettingConnectionType
Notify connection type. Here are more detailed structural descriptions.
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
Unknown connection.
@ SETTINGS_CONNECTION_TYPE_CLOUD
Cloud connection.
@ SETTINGS_CONNECTION_TYPE_DIRECT
Direct connection.
struct tagOverallStatisticInfo OverallStatisticInfo
ZoomSDKWallpaperSettingStatus
@ ZoomSDKWallpaperSettingStatus_DownloadFail
@ ZoomSDKWallpaperSettingStatus_Downloading
@ ZoomSDKWallpaperSettingStatus_Downloaded
@ ZoomSDKWallpaperSettingStatus_None
struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
SDK_AUDIO_DEVICE_RAW_MODE_TYPE
@ SDK_AUDIO_DEVICE_RAW_MODE_OFF
off
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
default mode
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
on
SettingsNetWorkType
Notify network type. Here are more detailed structural descriptions.
@ SETTINGS_NETWORK_UNKNOWN
Unknown network.
@ SETTINGS_NETWORK_WIRED
Wired LAN.
@ SETTINGS_NETWORK_OTHERS
Others.
@ SETTINGS_NETWORK_WIFI
WIFI.
@ SETTINGS_NETWORK_PPP
PPP.
LimitFPSValue
Specify the values of available limit fps. Here are more detailed enum descriptions.
@ limitfps_2_frame
2 frames per second.
@ limitfps_Not_Enable
The feature is not enabled.
@ limitfps_8_frame
8 frames per second.
@ limitfps_15_frame
15 frames per second.
@ limitfps_10_frame
10 frames per second.
@ limitfps_1_frame
1 frame per second.
@ limitfps_4_frame
4 frames per second.
@ limitfps_6_frame
6 frames per second.
SDK_ECHO_CANCELLATION_LEVEL
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_AGGRESSIVE
@ AutoFramingMode_center_coordinates
will use the center point of the video frame as the center for zoom-in
@ AutoFramingMode_face_recognition
will use the detected face in the video frame as the center to zoom-in
@ AutoFramingMode_none
No use of the auto-framing.
FaceRecognitionFailStrategy
@ FaceRecognitionFailStrategy_using_original_video
After face recognition fail, will use original video.
@ FaceRecognitionFailStrategy_none
No use of the fail strategy.
@ FaceRecognitionFailStrategy_remain
After face recognition fail, do nothing util face recognition success again.
@ FaceRecognitionFailStrategy_using_center_coordinates
After face recognition fail, will use center point of the video frame as the center for zoom-in.
ZoomSDKWallpaperLayoutMode
@ ZoomSDKWallpaperLayoutMode_Fill
@ ZoomSDKWallpaperLayoutMode_None
@ ZoomSDKWallpaperLayoutMode_Fit
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
float ratio
The zoom in ratio of auto-framing, valid range of values: 1~10(when mode is AutoFramingMode_center_co...
FaceRecognitionFailStrategy fail_Strategy
Only mode is AutoFramingMode_face_recognition, the param is valid.
Notify video status information. Here are more detailed structural descriptions.
float packetloss_recv_avg_
Receiving average packet loss, unit: %.
int jitter_recv_
Receiving jitter, unit: ms.
float packetloss_send_avg_
Sending average packet loss, unit: %.
int fps_send_
Frame per second sending.
int resolution_recv_
HIWORD->height, LOWORD->width.
int latency_send_
Sending latency, unit: ms.
int resolution_send_
HIWORD->height, LOWORD->width.
float packetloss_recv_max_
Receiving max packet loss, unit: %.
float packetloss_send_max_
Sending max packet loss, unit: %.
int fps_recv_
Frame per second receiving.
int latency_recv_
Receiving latency, unit: ms.
tagASVSessionStatisticInfo()
int jitter_send_
Sending jitter, unit: ms.
Notify the audio status information. Here are more detailed structural descriptions.
int jitter_send_
Sending jitter, unit: ms.
float packetloss_recv_
Receiving packet loss, unit: %.
int frequency_send_
Sending frequency, unit: KHz.
float packetloss_send_
Sending packet loss, unit: %.
tagAudioSessionStatisticInfo()
int frequency_recv_
Receiving frequency, unit: KHz.
int latency_send_
Sending latency, unit: ms.
int latency_recv_
Receiving latency, unit: ms.
int jitter_recv_
Receiving jitter, unit: ms.
Notify overall statistic information. Here are more detailed structural descriptions.
const zchar_t * proxy_addr_
Proxy address.
SettingsNetWorkType net_work_type_
Network type.
tagOverallStatisticInfo()
SettingConnectionType connection_type_
Connection type.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
SDK error types. Here are more detailed structural descriptions.