5#ifndef _SETTING_SERVICE_INTERFACE_H_
6#define _SETTING_SERVICE_INTERFACE_H_
9#include "zoom_sdk_util_define.h"
153typedef enum tagReactionSkinToneType
156 ReactionSkinTone_None = 0,
158 ReactionSkinTone_Default,
160 ReactionSkinTone_Light,
162 ReactionSkinTone_MediumLight,
164 ReactionSkinTone_Medium,
166 ReactionSkinTone_MediumDark,
168 ReactionSkinTone_Dark,
169}ReactionSkinToneType;
177 ZoomSDKUITheme_Bloom,
181 ZoomSDKUITheme_Agave,
183 ZoomSDKUITheme_Classic,
189enum ZoomSDKUIAppearance
192 ZoomSDKUIAppearance_Light = 1,
194 ZoomSDKUIAppearance_Dark,
196 ZoomSDKUIAppearance_System,
207 WindowSize_FullScreen,
211 WindowSize_CurrentSize,
220 SettingTabPage_General,
222 SettingTabPage_Audio,
224 SettingTabPage_Video,
230enum ScreenCaptureMode
233 CaptureMode_auto = 0,
237 CaptureMode_gpu_copy_filter,
239 CaptureMode_ada_copy_filter,
241 CaptureMode_ada_copy_without_filter,
243 CaptureMode_ada_secure_filter,
251enum ShareOptionInMeeting
254 ShareOptionInMeeting_AllOption,
256 ShareOptionInMeeting_AutoShareDesktop,
262enum ShareOptionToRoom
265 ShareOptionToRoom_AllOption,
267 ShareOptionToRoom_AutoShareDesktop,
286typedef struct tagShowSettingDlgParam
301 SettingTabPage eTabPageType;
302 tagShowSettingDlgParam()
307 hSettingWnd =
nullptr;
310 eTabPageType = SettingTabPage_General;
317typedef struct tagSettingDlgShowTabPageOption
326 bool bShowShareScreen;
328 bool bShowVirtualBackGround;
332 bool bShowAdvancedFeature;
334 bool bShowStatistics;
338 bool bShowKeyboardShortcuts;
340 bool bShowAccessibility;
341 tagSettingDlgShowTabPageOption()
346 bShowShareScreen =
true;
347 bShowVirtualBackGround =
true;
348 bSHowRecording =
true;
349 bShowStatistics =
true;
350 bShowAccessibility =
true;
351 bShowKeyboardShortcuts =
true;
352 bShowAdvancedFeature =
false;
353 bShowFeedback =
false;
356}SettingDlgShowTabPageOption;
361typedef struct tagSettingDlgShowUrlOption
364 bool bShowGeneralViewMoreSetting;
366 bool bShowVideoSupportCenter;
368 bool bShowAudioLearnMore;
370 bool bShowShareAndVBLearnMore;
371 tagSettingDlgShowUrlOption()
373 bShowGeneralViewMoreSetting =
true;
374 bShowVideoSupportCenter =
true;
375 bShowAudioLearnMore =
true;
376 bShowShareAndVBLearnMore =
true;
379}SettingDlgShowUrlOption;
398class ITestAudioDeviceHelperEvent
401 virtual ~ITestAudioDeviceHelperEvent() {}
408 virtual void OnMicSpkVolumeChanged(
unsigned int MicVolume,
unsigned int SpkVolume) = 0;
414 virtual void OnNoAudioDeviceIsUseful(
bool bMicOrSpk) = 0;
422 virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,
bool& bHandled) = 0;
427 virtual void OnSelectedAudioDeviceIsChanged() = 0;
434class ITestAudioDeviceHelper
443 virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;
451 virtual SDKError TestMicStartRecording(
const zchar_t* deviceID =
nullptr) = 0;
458 virtual SDKError TestMicStopTesting() = 0;
465 virtual SDKError TestMicPlayRecording() = 0;
473 virtual SDKError TestSpeakerStartPlaying(
const zchar_t* deviceID =
nullptr) = 0;
480 virtual SDKError TestSpeakerStopPlaying() = 0;
489 virtual SDKError SetTimerInterval(
unsigned int timerInterval) = 0;
548 virtual SDKError EnableDualScreenMode(
bool bEnable) = 0;
554 virtual bool IsDualScreenModeEnabled() = 0;
562 virtual SDKError TurnOffAeroModeInSharing(
bool bTurnoff) = 0;
568 virtual bool IsAeroModeInSharingTurnOff() = 0;
575 virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(
bool bEnable) = 0;
581 virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled() = 0;
588 virtual SDKError EnableSplitScreenMode(
bool bEnable) = 0;
594 virtual bool IsSplitScreenModeEnabled() = 0;
601 virtual SDKError EnableDisplayReminderWindowWhenExit(
bool bEnable) = 0;
607 virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
614 virtual SDKError EnableShowMyMeetingElapseTime(
bool bEnable) = 0;
620 virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;
627 virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone) = 0;
633 virtual ReactionSkinToneType GetReactionSkinTone() = 0;
639 virtual bool IsSupportSetUITheme() = 0;
646 virtual SDKError SetUITheme(ZoomSDKUITheme theme) = 0;
652 virtual ZoomSDKUITheme GetUITheme() = 0;
658 virtual bool IsSupportSetUIAppearance() = 0;
665 virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance) = 0;
671 virtual ZoomSDKUIAppearance GetUIAppearance() = 0;
682 PREVIEW_VIDEO_ROTATION_ACTION_0,
684 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
686 PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
688 PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
689} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;
697 VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
699 VIDEO_HARDWARE_ENCODE_SENDING,
701 VIDEO_HARDWARE_ENCODE_PROCESSING,
702}VIDEO_HARDWARE_ENCODE_TYPE;
708class ITestVideoDeviceHelperEvent
711 virtual ~ITestVideoDeviceHelperEvent() {}
716 virtual void OnNoVideoDeviceIsUseful() = 0;
721 virtual void OnSelectedVideoDeviceIsChanged() = 0;
726 virtual void OnNoWindowToShowPreview() = 0;
733class ITestVideoDeviceHelper
742 virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
751 virtual SDKError SetVideoPreviewParentWnd(
HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
760 virtual SDKError TestVideoStartPreview(
const zchar_t* deviceID =
nullptr) = 0;
767 virtual SDKError TestVideoStopPreview() = 0;
775 virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action) = 0;
777 virtual ICameraController* GetTestCameraController() = 0;
784class ILipSyncAvatarPreviewHelperEvent
787 virtual ~ILipSyncAvatarPreviewHelperEvent() {}
792 virtual void OnNoWindowToShowLipsyncPreview() = 0;
799class ILipSyncAvatarPreviewHelper
808 virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent* pEvent) = 0;
817 virtual SDKError SetLipSyncAvatarPreviewParentWnd(
HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
824 virtual SDKError StartLipSyncAvatarPreview() = 0;
831 virtual SDKError StopLipSyncAvatarPreview() = 0;
833 virtual ~ILipSyncAvatarPreviewHelper() {};
840class I3DAvatarImageInfo
847 virtual bool IsSelected() = 0;
853 virtual bool IsLastUsed() = 0;
859 virtual const zchar_t* GetImageFilePath() = 0;
865 virtual const zchar_t* GetImageName() = 0;
872 virtual int GetIndex() = 0;
874 virtual ~I3DAvatarImageInfo() {};
1189 virtual SDKError EnableVideoMirrorEffect(
bool bEnable) = 0;
1195 virtual bool IsVideoMirrorEffectEnabled() = 0;
1202 virtual SDKError EnableSpotlightSelf(
bool bEnable) = 0;
1208 virtual bool IsSpotlightSelfEnabled() = 0;
1215 virtual SDKError EnableHardwareEncode(
bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
1221 virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;
1228 virtual SDKError Enable49VideoesInGallaryView(
bool bEnable) = 0;
1234 virtual bool Is49VideoesInGallaryViewEnabled() = 0;
1241 virtual SDKError EnableHideNoVideoUsersOnWallView(
bool bEnable) = 0;
1247 virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;
1254 virtual SDKError EnableVideoPreviewDialog(
bool bEnable) = 0;
1260 virtual bool IsVideoPreviewDialogEnabled() = 0;
1267 virtual SDKError EnableStopIncomingVideo(
bool bEnable) = 0;
1273 virtual bool IsStopIncomingVideoEnabled() = 0;
1281 virtual SDKError EnableHideSelfView(
bool bEnable) = 0;
1289 virtual SDKError IsHideSelfViewEnabled(
bool& bEnabled) = 0;
1295 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
1559 virtual SDKError EnableStereoAudio(
bool bEnable) = 0;
1565 virtual bool IsStereoAudioEnable() = 0;
1571 virtual bool IsMicOriginalInputEnable() = 0;
1578 virtual SDKError EnableHoldSpaceKeyToSpeak(
bool bEnable) = 0;
1584 virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;
1590 virtual ITestAudioDeviceHelper* GetTestAudioDeviceHelper() = 0;
1597 virtual SDKError EnableSyncButtonsOnHeadset(
bool bEnable) = 0;
1603 virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;
1611 virtual SDKError EnableHighFidelityMusicMode(
bool bEnable) = 0;
1617 virtual bool IsHighFidelityMusicModeDisabled() = 0;
1619 virtual SDKError EnableAlwaysUseSeparateRingSpk(
bool bEnable) = 0;
1621 virtual bool IsAlwaysUseSeparateRingSpk() = 0;
1623 virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio() = 0;
1768 virtual SDKError EnableSelectRecordFileLocationAfterMeeting(
bool bEnable) = 0;
1774 virtual bool IsSelectRecordFileLocationAfterMeetingEnabled() = 0;
2028 virtual void onPersonalWallpaperChanged(
IWallpaperItem* item) = 0;
2097 virtual bool IsPersonalWallpaperEnabled() = 0;
2135class IAccessibilitySettingContext
2143 virtual SDKError EnableAlwaysShowMeetingControls(
bool bEnable) = 0;
2150 virtual SDKError IsAlwaysShowMeetingControlsEnable(
bool& bEnable) = 0;
2157class ISettingUIStrategy
2164 virtual void DisableAdvancedFeatures4GeneralSetting(
bool bDisable) = 0;
2171 virtual void DisableAccountSettingTabPage(
bool bDisable) = 0;
2177 virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;
2183 virtual void HideAutoCopyInviteLinkCheckBox(
bool bHide) = 0;
2189 virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption) = 0;
2195class IVirtualBGImageInfo
2202 virtual bool isSelected() = 0;
2208 virtual bool isAllowDelete() = 0;
2213 virtual const zchar_t* GetImageFilePath() = 0;
2219 virtual const zchar_t* GetImageName() = 0;
2221 virtual ~IVirtualBGImageInfo() {};
2225 VB_VideoError_None = 0,
2226 VB_VideoError_UnknownFormat,
2227 VB_VideoError_ResolutionHigh1080P,
2228 VB_VideoError_ResolutionHigh720P,
2229 VB_VideoError_ResolutionLow,
2230 VB_VideoError_PlayError,
2231 VB_VideoError_OpenError,
2238class IVirtualBGSettingContextEvent
2241 virtual ~IVirtualBGSettingContextEvent() {}
2246 virtual void onVBImageDidDownloaded() = 0;
2252 virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;
2257 virtual void onSelectedVBImageChanged() = 0;
2263 virtual void OnVideoThumbReady(
const zchar_t* file_path) = 0;
2270 virtual void OnVideoThumbError(
const zchar_t* file_path, VBVideoError error) = 0;
2277 virtual void OnVideoPlayError(
const zchar_t* file_path, VBVideoError error) = 0;
2284class IVirtualBGSettingContext
2293 virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent* pEvent) = 0;
2299 virtual bool IsSupportVirtualBG() = 0;
2305 virtual bool IsDeviceSupportSmartVirtualBG() = 0;
2311 virtual bool IsSupportVirtualBackgroundVideo() = 0;
2318 virtual bool IsDeviceSupportSmartVirtualBackgroundVideo() = 0;
2325 virtual bool IsDeviceSupportGreenVirtualBackgroundVideo() = 0;
2331 virtual bool IsUsingGreenScreenOn() = 0;
2339 virtual SDKError SetUsingGreenScreen(
bool bUse) = 0;
2345 virtual bool IsAllowToAddNewVBItem() = 0;
2352 virtual bool isAllowToRemoveVBItem() = 0;
2366 virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;
2379 virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;
2385 virtual DWORD GetBGReplaceColor() = 0;
2391 virtual SDKError BeginSelectReplaceVBColor() = 0;
2405 virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;
2418 virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;
2424 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2429 ZoomSDKVideoEffectType_None = 0,
2430 ZoomSDKVideoEffectType_Filter = 1,
2431 ZoomSDKVideoEffectType_Frame = 2,
2432 ZoomSDKVideoEffectType_CustomFilter = 3,
2433 ZoomSDKVideoEffectType_Sticker = 4,
2434}ZoomSDKVideoEffectType;
2440class IVideoFilterImageInfo
2447 virtual bool isSelected() = 0;
2453 virtual const zchar_t* GetImageFilePath() = 0;
2459 virtual const zchar_t* GetImageName() = 0;
2466 virtual ZoomSDKVideoEffectType GetType() = 0;
2473 virtual int GetIndex() = 0;
2475 virtual ~IVideoFilterImageInfo() {};
2482class IVideoFilterSettingContextEvent
2488 virtual void onVideoFilterItemThumnailsDownloaded() = 0;
2495 virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type,
int index) = 0;
2503 virtual void onVideoFilterItemDataDownloaded(
bool bSuccess, ZoomSDKVideoEffectType type,
int index) = 0;
2510class IVideoFilterSettingContext
2519 virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent* pEvent) = 0;
2526 virtual bool IsSupportVideoFilter() = 0;
2532 virtual bool IsVideoFilterEnabled() = 0;
2538 virtual bool IsVideoFilterLocked() = 0;
2551 virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;
2557 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2564class I3DAvatarSettingContextEvent
2567 virtual ~I3DAvatarSettingContextEvent() {}
2572 virtual void on3DAvatarItemThumbnailsDownloaded() = 0;
2578 virtual void on3DAvatarItemDataDownloading(
int index) = 0;
2585 virtual void on3DAvatarItemDataDownloaded(
bool bSuccess,
int index) = 0;
2592class I3DAvatarSettingContext
2601 virtual SDKError SetEvent(I3DAvatarSettingContextEvent* pEvent) = 0;
2607 virtual bool Is3DAvatarSupportedByDevice() = 0;
2613 virtual bool Is3DAvatarEnabled() = 0;
2620 virtual SDKError Enable3DAvatarEffectForAllMeeting(
bool bEnable) = 0;
2626 virtual bool Is3DAvatarEffectForAllMeetingEnabled() = 0;
2639 virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;
2645 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2652 virtual ILipSyncAvatarPreviewHelper* GetLipSyncAvatarPreviewHelper() = 0;
2657 ZoomSDKFaceMakeupType_Mustache,
2658 ZoomSDKFaceMakeupType_Eyebrow,
2659 ZoomSDKFaceMakeupType_Lip
2660}ZoomSDKFaceMakeupType;
2666class IFaceMakeupImageInfo
2673 virtual ZoomSDKFaceMakeupType GetFaceMakeupType() = 0;
2679 virtual bool IsSelected() = 0;
2685 virtual const zchar_t* GetImageFilePath() = 0;
2691 virtual const zchar_t* GetImageName() = 0;
2698 virtual int GetIndex() = 0;
2700 virtual ~IFaceMakeupImageInfo() {};
2707class IFaceMakeupSettingContextEvent
2710 virtual ~IFaceMakeupSettingContextEvent() {}
2715 virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type) = 0;
2721 virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type,
int index) = 0;
2728 virtual void onFaceMakeupItemDataDownloaded(
bool bSuccess, ZoomSDKFaceMakeupType type,
int index) = 0;
2735class IFaceMakeupSettingContext
2744 virtual SDKError SetEvent(IFaceMakeupSettingContextEvent* pEvent) = 0;
2750 virtual bool IsFaceMakeupEnabled() = 0;
2756 virtual bool IsSupportFaceMakeup() = 0;
2763 virtual SDKError EnableFaceMakeupEffectForAllMeeting(
bool bEnable) = 0;
2769 virtual bool IsFaceMakeupEffectForAllMeetingEnabled() = 0;
2782 virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo* pImage) = 0;
2789 virtual SDKError SetLipsFaceMakeup(
bool bEnable) = 0;
2797 virtual SDKError SetColor(ZoomSDKFaceMakeupType type,
unsigned long color) = 0;
2805 virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type,
unsigned int opactity) = 0;
2811 virtual SDKError ResetAllFaceMakeupEffect() = 0;
2817 virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
2979 virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType) = 0;
2984 virtual WindowSizeType GetWindowSizeTypeWhenViewShare() = 0;
2991 virtual SDKError EnableRemoteControlAllApplications(
bool bEnable) = 0;
2997 virtual bool IsRemoteControlAllApplicationsEnabled() = 0;
3004 virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting& shareOption) = 0;
3011 virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption) = 0;
3018 virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode& select_mode) = 0;
3025 virtual SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode) = 0;
3032 virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom& share_option) = 0;
3039 virtual SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option) = 0;
3046 virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode) = 0;
3053 virtual SDKError GetScreenCaptureMode(ScreenCaptureMode& capture_mode) = 0;
3108 virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;
3115 virtual SDKError HideSettingDlg() = 0;
3121 virtual IAccessibilitySettingContext* GetAccessibilitySettings() = 0;
3127 virtual ISettingUIStrategy* GetSettingUIStrategy() = 0;
3133 virtual IVirtualBGSettingContext* GetVirtualBGSettings() = 0;
3139 virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;
3145 virtual I3DAvatarSettingContext* Get3DAvatarSettings() = 0;
3151 virtual IFaceMakeupSettingContext* GetFaceMakeupSettings() = 0;
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 ~IAudioSettingContextEvent()
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.
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
Enumeration of light adaption type.
Suppress_Background_Noise_Level
Enumeration of the level to suppress background noise. For more information, please visit https://sup...
@ Suppress_BGNoise_Level_Low
@ Suppress_BGNoise_Level_None
@ Suppress_BGNoise_Level_Medium
@ Suppress_BGNoise_Level_High
@ Suppress_BGNoise_Level_Auto
SettingConnectionType
Enumeration of the connection type.
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
@ SETTINGS_CONNECTION_TYPE_CLOUD
@ SETTINGS_CONNECTION_TYPE_DIRECT
struct tagOverallStatisticInfo OverallStatisticInfo
Overall statistic information.
ZoomSDKWallpaperSettingStatus
@ ZoomSDKWallpaperSettingStatus_DownloadFail
@ ZoomSDKWallpaperSettingStatus_Downloading
@ ZoomSDKWallpaperSettingStatus_Downloaded
@ ZoomSDKWallpaperSettingStatus_None
struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
The audio status information.
SDK_AUDIO_DEVICE_RAW_MODE_TYPE
Enumeration of signal processing by Windows audio device drivers. For more information,...
@ SDK_AUDIO_DEVICE_RAW_MODE_OFF
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
SettingsNetWorkType
Enumeration of the network type.
@ SETTINGS_NETWORK_UNKNOWN
@ SETTINGS_NETWORK_OTHERS
LimitFPSValue
Enumeration of the values to limit fps.
SDK_ECHO_CANCELLATION_LEVEL
Enumeration for echo cancellation. For more information, please visit https://support....
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_HIGH
@ SDK_ECHO_CANCELLATION_LOW
AutoFramingMode
Enumeration of the auto framing modes in video.
@ AutoFramingMode_center_coordinates
@ AutoFramingMode_face_recognition
FaceRecognitionFailStrategy
Enumeration of the face recognition failure strategies.
@ FaceRecognitionFailStrategy_using_original_video
@ FaceRecognitionFailStrategy_none
@ FaceRecognitionFailStrategy_remain
@ FaceRecognitionFailStrategy_using_center_coordinates
ZoomSDKWallpaperLayoutMode
@ ZoomSDKWallpaperLayoutMode_Fill
@ ZoomSDKWallpaperLayoutMode_None
@ ZoomSDKWallpaperLayoutMode_Fit
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
The video status information.
FaceRecognitionFailStrategy fail_Strategy
The video status information.
float packetloss_recv_avg_
float packetloss_send_avg_
float packetloss_recv_max_
float packetloss_send_max_
tagASVSessionStatisticInfo()
The audio status information.
tagAudioSessionStatisticInfo()
Overall statistic information.
const zchar_t * proxy_addr_
SettingsNetWorkType net_work_type_
tagOverallStatisticInfo()
SettingConnectionType connection_type_
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.