6#ifndef _SETTING_SERVICE_INTERFACE_H_
7#define _SETTING_SERVICE_INTERFACE_H_
3D avatar image information interface.
virtual ~I3DAvatarImageInfo()
virtual const wchar_t * GetImageName()=0
Get the name 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.
virtual const wchar_t * GetImageFilePath()=0
Get the file path of the current image.
3D avatar context callback event.
virtual void on3DAvatarItemThumbnailsDownloaded()=0
Callback event notifying that all 3D avatar items' thumbnails have been downloaded.
virtual void on3DAvatarItemDataDownloading(int index)=0
Callback event notifying that the selected 3d avatar item is downloading.
virtual ~I3DAvatarSettingContextEvent()
virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index)=0
Callback event notifying 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 video filter images.
virtual bool Is3DAvatarSupportedByDevice()=0
Determine if the 3D avatar feature is supported by video device.
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 video filter 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 onDefaultSpeakerDeviceChanged(const wchar_t *deviceId, const wchar_t *deviceName)=0
Notify the user that a speaker device is selected.
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 wchar_t *deviceId, const wchar_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 SDKError SetRingSpkDevice(const wchar_t *spk_id)=0
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 SDKError SelectMic(const wchar_t *deviceId, const wchar_t *deviceName)=0
Select mic device.
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 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 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 SelectSpeaker(const wchar_t *deviceId, const wchar_t *deviceName)=0
Select speaker device.
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 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 wchar_t * GetDeviceName()=0
Get the camera device name.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const wchar_t * GetDeviceId()=0
Get the camera device ID.
General setting interface.
virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable)=0
Enable/Disable to show the elapsed time of the meeting.
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 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 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 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 ~ILipSyncAvatarPreviewHelperEvent()
virtual void OnNoWindowToShowLipsyncPreview()=0
A window is needed to show the lip-sync preview. This event notifies that there is no window handle o...
lip-sync avatar preview helper interface.
virtual ~ILipSyncAvatarPreviewHelper()
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.
lip sync avatar context Callback Event.
virtual ~ILipSyncAvatarSettingContextEvent()
virtual void onLipSyncAvatarItemThumbnailsDownloaded()=0
Callback event of notification that the thumbnails of all lip sync avatar items have been downloaded.
virtual void onLipSyncAvatarItemDataDownloaded(bool bSuccess, int index)=0
Callback event notifying that the selected lip-sync avatar item has been downloaded successfully.
virtual void onLipSyncAvatarItemDataDownloading(int index)=0
Callback event notifying that the selected lip sync avatar item is downloading.
Lip sync avatar setting interface.
virtual SDKError SetEvent(ILipSyncAvatarSettingContextEvent *pEvent)=0
Lip sync avatar callback handler.
virtual bool Is3DAvatarSupportedByDevice()=0
Determine if the lip-sync avatar feature is supported by video device.
virtual bool IsLipSyncAvatarEnabled()=0
Determine if the lip-sync avatar feature is enabled.
virtual SDKError SetLipSyncAvatarImage(I3DAvatarImageInfo *pImage)=0
Specify an image to be the lip sync avatar image.
virtual ILipSyncAvatarPreviewHelper * GetLipSyncAvatarPreviewHelper()=0
Get the pointer to ILipSyncAvatarPreviewHelper which is used to preview the lip-sync avatar.
virtual IList< I3DAvatarImageInfo * > * GetLipSyncAvatarImageList()=0
Get the list of the lip-sync avatar images.
Microphone device information interface.
virtual bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const wchar_t * GetDeviceId()=0
Get the microphone device ID.
virtual const wchar_t * GetDeviceName()=0
Get the microphone device name.
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 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 wchar_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 SDKError SetRecordingPath(const wchar_t *szPath)=0
Set the path to save the recording file.
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 const wchar_t * GetRecordingManagementURL()=0
Get the recording management URL. It returns the real url only after you retrieve the callback IRecor...
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 wchar_t * GetDeviceId()=0
Get the ring speaker device ID.
virtual const wchar_t * GetDeviceName()=0
Get the ring speaker device name.
Meeting setting 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 ¶m)=0
Display Meeting Setting dialog.
virtual IGeneralSettingContext * GetGeneralSettings()=0
Get general setting interface.
virtual IVideoFilterSettingContext * GetVideoFilterSettings()=0
Get video filter 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.
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 SDKError SetShareOptionwWhenShareInDirectShare(ShareOptionToRoom share_option)=0
Get the share option to room.
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 SetShareOptionwWhenShareInMeeting(ShareOptionInMeeting shareOption)=0
Set 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 GetShareOptionwWhenShareInMeeting(ShareOptionInMeeting &shareOption)=0
Get the share option in meeting.
virtual SDKError EnableRemoteControlAllApplications(bool bEnable)=0
Enable/disable remote control of all applications.
virtual SDKError GetShareOptionwWhenShareInDirectShare(ShareOptionToRoom &share_option)=0
Get the share option to room.
virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode &select_mode)=0
Get the share select mode.
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 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 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 bool IsSelectedDevice()=0
Determine if the current device is selected to use.
virtual const wchar_t * GetDeviceId()=0
Get the speaker device ID.
virtual const wchar_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 OnMicSpkVolumnChanged(unsigned int MicVolume, unsigned int SpkVolume)=0
Notify the current mic or speaker volume when testing.
virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status, bool &bHandled)=0
Notify the mic status when testing.
virtual ~ITestAudioDeviceHelperEvent()
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 TestMicStartRecording(const wchar_t *deviceID=NULL)=0
Start to test the mic.
virtual SDKError SetEvent(ITestAudioDeviceHelperEvent *pEvent)=0
Audio device test callback handler.
virtual SDKError TestSpeakerStartPlaying(const wchar_t *deviceID=NULL)=0
Start to test the speaker.
virtual SDKError TestSpeakerStopPlaying()=0
Stop the speaker test. The SDK will return an error if there is no speaker test.
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
Notify the user that a camera device is selected during the test, then the SDK will close the video t...
virtual void OnNoWindowToShowPreview()=0
A window is needed to show the video preview. This event notifies that there is no window handle or a...
virtual void OnNoVideoDeviceIsUseful()=0
Notify that no camera device is found.
virtual ~ITestVideoDeviceHelperEvent()
Video device test interface.
virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action)=0
Rotate the video preview.
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 SDKError TestVideoStartPreview(const wchar_t *deviceID=NULL)=0
Start to test the camera.
virtual ICameraController * GetTestCameraController()=0
Video filter image information interface.
virtual ZoomSDKVideoEffectType GetType()=0
Get the type of current image.
virtual const wchar_t * GetImageName()=0
Get the name of current image.
virtual int GetIndex()=0
Get the index of current image.
virtual ~IVideoFilterImageInfo()
virtual const wchar_t * GetImageFilePath()=0
Get the file path of current image.
virtual bool isSelected()=0
Determine the usage of current image.
Video filter context Callback Event.
virtual void onVideoFilterItemDataReady(bool bSuccess, ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item whether has been downloaded succes...
virtual void onVideoFilterItemDataNeedPrepare(ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item needs to download.
virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item is downloading.
virtual void onVideoFilterItemThumnailsDownloaded()=0
Callback event of notification that the thumbnails of all video filter items have been downloaded.
virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the selected video filter item whether has been downloaded succes...
virtual void onVideoFilterItemDataDownloaded(ZoomSDKVideoEffectType type, int index)=0
Callback event of notification that the thumbnail of the video filter item has been download.
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 wchar_t *deviceId, const wchar_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 EnableVideoPreviewDialog(bool bEnable)=0
Enable or disable to show the video preview dialog when join meeting.
virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
Enable or disable the hardware acceleration.
virtual SDKError SelectCamera(const wchar_t *deviceId)=0
Select camera device.
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 Enable49VideoesInGallaryView(bool bEnable)=0
Enable or disable to show the participants in Gallery View up to 49 per screen.
virtual SDKError EnableAlwaysUseOriginalSizeVideo(bool bEnable)=0
Enable or disable always use original size video.
virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType()=0
Get the light adaption type of the video.
virtual unsigned int GetFaceBeautyStrengthValue()=0
Get the video facial beauty strength value.
virtual bool IsVideoMirrorEffectEnabled()=0
Get the flag to enable/disable the video mirror effect.
virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable)=0
Enable or disable to hide the non-video participants.
virtual bool IsAlwaysUse16v9()=0
Get the flag to enable/disable the 16V9 video mode.
virtual bool IsHideNoVideoUsersOnWallViewEnabled()=0
Get the flag to enable/disable to hide non-video participants.
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 double GetLightAdaptionManualValue()=0
Get the manual setting value for the light adaption of the video.
virtual bool IsLipSyncAvatarWhenVideoOffEnabled()=0
Get the flag to enable or disable audio-only 3d avatar when the user's video is off.
virtual bool IsSupportLipSyncAvatar()=0
Determine whether to show audio-only avatar when the user's video feature is supported by the meeting...
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 EnableLipSyncAvatarWhenVideoOff(bool bEnable)=0
Enable or disable audio-only 3d avatar when the user's video is off.
virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue)=0
Set the video facial beauty strength value.
virtual ILipSyncAvatarSettingContext * GetLipSyncAvatarSettingContext()=0
Get the pointer to ILipSyncAvatarSettingContext which is used to set lip sync avatar.
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 EnableAlwaysUse16v9(bool bEnable)=0
Enable or disable the 16V9 video mode.
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 background image information interface.
virtual const wchar_t * GetImageName()=0
Get the name of current image.
virtual ~IVirtualBGImageInfo()
virtual bool isSelected()=0
Determine the usage of current image.
virtual const wchar_t * GetImageFilePath()=0
Get the file path of current image.
virtual bool isAllowDelete()=0
Determine the current image can be deleted from the list.
Virtual background context Callback Event.
virtual void OnVideoThumbError(const wchar_t *file_path, VBVideoError error)=0
Callback event of notification that creating the thumb of a virtual background video is failed.
virtual ~IVirtualBGSettingContextEvent()
virtual void OnVideoThumbReady(const wchar_t *file_path)=0
Callback event of notification that creating the thumb of a virtual background video is success.
virtual void onVBImageDidDownloaded()=0
Callback event of notification that the default virtual background images supplied by ZOOM are downlo...
virtual void onSelectedVBImageChanged()=0
Callback event of notification that the virtual background image is changed.
virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor)=0
Callback event of notification that the virtual background effect is updated with the selected color.
virtual void OnVideoPlayError(const wchar_t *file_path, VBVideoError error)=0
Callback event of notification that playing 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 SDKError AddBGVideo(const wchar_t *file_path)=0
Add a new video as the virtual background video and to the video list.
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 SDKError AddBGImage(const wchar_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 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 bool IsSupportSmartVirtualBG()=0
Determine if the smart virtual background feature can be supported by the machine.
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 IsUsingGreenScreenOn()=0
Determine if the green screen is using for the virtual background feature in the meeting.
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.
@ CaptureMode_gpu_copy_filter
@ CaptureMode_ada_secure_filter
@ CaptureMode_ada_copy_filter
@ CaptureMode_ada_copy_without_filter
PREVIEW_VIDEO_ROTATION_ACTION
Notify to rotate the video preview based on the current view. Here are more detailed structural descr...
@ PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180
Rotate 180 degrees.
@ PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90
Rotate to the left.
@ PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
Rotate to the right.
@ PREVIEW_VIDEO_ROTATION_ACTION_0
No rotation.
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
VIDEO_HARDWARE_ENCODE_TYPE
@ VIDEO_HARDWARE_ENCODE_PROCESSING
@ VIDEO_HARDWARE_ENCODE_SENDING
@ VIDEO_HARDWARE_ENCODE_RECEIVING
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.
@ ZoomSDKVideoEffectType_Frame
@ ZoomSDKVideoEffectType_None
@ ZoomSDKVideoEffectType_Filter
@ ZoomSDKVideoEffectType_Sticker
@ VB_VideoError_ResolutionLow
@ VB_VideoError_UnknowFormat
@ VB_VideoError_PlayError
@ VB_VideoError_ResolutionHigh1080P
@ VB_VideoError_ResolutionHigh720P
@ VB_VideoError_OpenError
struct tagShowSettingDlgParam ShowSettingDlgParam
struct tagOverallStatisticInfo OverallStatisticInfo
struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
SDK_AUDIO_DEVICE_RAW_MODE_TYPE
@ SDK_AUDIO_DEVICE_RAW_MODE_OFF
@ SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT
@ SDK_AUDIO_DEVICE_RAW_MODE_ON
struct tagSettingDlgShowTabPageOption SettingDlgShowTabPageOption
@ ReactionSkinTone_Medium
@ ReactionSkinTone_MediumDark
@ ReactionSkinTone_Default
@ ReactionSkinTone_MediumLight
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_TESTMIC_STATUS
Notify the status of the mic when testing. Here are more detailed structural descriptions.
@ enuCanTest
Test the mic via TestMicStartRecording. It is useless to call TestMicStopTesting/TestMicPlayRecording...
@ enuMicRecording
Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless to call TestMicStartRecording...
@ enuCanPlay
Test the mic via TestMicStopTesting/TestMicPlayRecording. It is useless call TestMicStartRecording in...
SDK_ECHO_CANCELLATION_LEVEL
@ SDK_ECHO_CANCELLATION_DEFAULT
@ SDK_ECHO_CANCELLATION_AGGRESSIVE
@ ShareOptionToRoom_AllOption
@ ShareOptionToRoom_AutoShareDesktop
struct tagSettingDlgShowUrlOption SettingDlgShowUrlOption
@ ShareOptionInMeeting_AutoShareDesktop
@ ShareOptionInMeeting_AllOption
enum tagReactionSkinToneType ReactionSkinToneType
struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
SettingTabPage
Specify the shown tab page at the top of the displayed setting dialog. Here are more detailed enum de...
@ SettingTabPage_Video
Video setting page.
@ SettingTabPage_Audio
Audio setting page.
@ SettingTabPage_General
General setting page.
enum PREVIEW_VIDEO_ROTATION_ACTION * PPREVIEW_VIDEO_ROTATION_ACTION
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.
SettingsNetWorkType net_work_type_
Network type.
tagOverallStatisticInfo()
const wchar_t * proxy_addr_
Proxy address.
SettingConnectionType connection_type_
Connection type.
Define the strategy to show the tab pages in the setting dialog. Here are more detailed structural de...
bool bShowAudio
True indicates to show audio page.
tagSettingDlgShowTabPageOption()
bool bSHowRecording
True indicates to show recording page.
bool bShowAccessibility
True indicates to show accessibility page.
bool bShowShareScreen
True indicates to show share screen page.
bool bShowKeyboardShortcuts
True indicates to show keyboard shortcuts page.
bool bShowVideo
True indicates to show video page.
bool bShowGeneral
True indicates to show general page.
bool bShowAdvancedFeature
True indicates to show advance feature page.
bool bShowVirtualBackGround
True indicates to show virtual background page.
bool bShowStatistics
True indicates to show staticstics page.
bool bShowFeedback
True indicates to show feed back page.
Define the strategy to show the url in the setting dialog. Here are more detailed structural descript...
bool bShowShareAndVBLearnMore
True indicates to show the learn more url of screen capture mode in share screen and vb page.
bool bShowAudioLearnMore
True indicates to show the learn more url of suppress background noise in audio page.
tagSettingDlgShowUrlOption()
bool bShowGeneralViewMoreSetting
True indicates to the view more setting url in general page.
bool bShowVideoSupportCenter
True indicates to show the support center url in video page.
bool bShow
Enable to display or nor.
bool bCenter
Enable to display the dialog at the center of the screen and discard the value of top and left.
SettingTabPage eTabPageType
The tab page shown at the top of the displayed setting dialog.
HWND hSettingWnd
Window handle of the dialog setting.
int top
The Y-axis value of the top-left corner of the dialog uses the coordinate system of the monitor.
int left
The X-axis value of the top-left corner of the dialog uses the coordinate system of the monitor.
HWND hParent
Parent window handle.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
const RECT _SDK_TEST_VIDEO_INIT_RECT
SDKError
SDK error types. Here are more detailed structural descriptions.