Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_sharing_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_SHARING_INTERFACE_H_
7#define _MEETING_SHARING_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
23
33
66
77
85
95
99{
100public:
102 virtual SDKError Cancel() = 0;
103
105 virtual SDKError Confirm() = 0;
106
108};
109
113{
114public:
116
120 virtual void onSharingStatus(ZoomSDKSharingSourceInfo shareInfo) = 0;
121
123 virtual void onFailedToStartShare() = 0;
124
128 virtual void onLockShareStatus(bool bLocked) = 0;
129
133
137
141
143 virtual void onSharedVideoEnded() = 0;
144
148
152};
153
157{
158public:
164#if defined(WIN32)
170 virtual SDKError StartAppShare(HWND hwndSharedApp) = 0;
171
175 virtual bool IsShareAppValid(HWND hwndSharedApp) = 0;
176
182 virtual SDKError StartMonitorShare(const zchar_t* monitorID) = 0;
183
189
195
201
214 virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
215
222
228 virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio) = 0;
229
235 virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool bEnable) = 0;
236
242 virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool& bCan) = 0;
243
251 virtual SDKError ViewShare(unsigned int shareSourceID, SDKViewType type) = 0;
252
259
265
271
276 virtual SDKError StartShareCamera(const zchar_t* deviceID, HWND hWnd) = 0;
277
283#endif
284
291
296 virtual SDKError StopShare() = 0;
297
303 virtual SDKError LockShare(bool isLock) = 0;
304
310
316
322
329
334 virtual bool CanStartShare() = 0;
335
339 virtual bool CanStartShare(CannotShareReasonType& reason) = 0;
340
344 virtual bool IsDesktopSharingEnabled() = 0;
345
351 virtual SDKError IsShareLocked(bool& bLocked) = 0;
352
358 virtual bool IsSupportEnableShareComputerSound(bool& bCurEnableOrNot) = 0;
359
365 virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool& bCurEnableOrNot) = 0;
366
371
375
376 // \brief Determine if the current meeting enabled sharing with compute sound or not before sharing.
379
385 virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
386
387 // \brief Determine if the current sharing content enabled sharing with compute sound or not.
390
397
404
411
412 // \brief Determine if the current meeting supports sharing with optimize video or not.
415
416 // \brief Determine if the current meeting enabled sharing with optimize video or not.
419
426
427 // \brief Determine if the current sharing content enabled sharing with optimize video or not.
430
437
443
449
454 virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
455
460
463 virtual bool CanShareVideoFile() = 0;
464
465#if defined(WIN32)
470 virtual SDKError CanEnableShareToBO(bool& bCan) = 0;
471
477 virtual SDKError EnableShareToBO(bool bEnable) = 0;
478
484 virtual SDKError IsShareToBOEnabled(bool& bEnabled) = 0;
485
490 virtual SDKError StartVideoFileShare(const zchar_t* filePath) = 0;
491
492
496
499
502#endif
503};
505#endif
Meeting share controller interface.
virtual SDKError StartWhiteBoardShare()=0
Start sharing with White board.
virtual bool IsEnableShareComputerSoundOnWhenSharing()=0
virtual SDKError PauseCurrentSharing()=0
Pause the current sharing.
virtual bool CanShareVideoFile()=0
Determine whether the user can share video files.
virtual SDKError EnableShareComputerSoundWhenSharing(bool bEnable)=0
Set to enable or disable the computer audio when sharing.
virtual SDKError IsSupportAdvanceShareOption(AdvanceShareOption option_)=0
Determine if the specified ADVANCE SHARE OPTION is supported.
virtual SDKError SetMultiShareSettingOptions(MultiShareOption shareOption)=0
Set the options for multi-participants share.
virtual SDKError ViewShare(unsigned int shareSourceID, SDKViewType type)=0
View the share from the specified user.
virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle=true)=0
Block the window when sharing in full screen. Once the function is called, you need to redraw the win...
virtual SDKError SetEvent(IMeetingShareCtrlEvent *pEvent)=0
Set meeting share controller callback event handler.
virtual SDKError StartShareCamera()=0
Start sharing camera.
virtual const zchar_t * getWhiteboardLegalNoticesExplained()=0
Get the white board legal notices explained.
virtual SDKError StartAppShare(HWND hwndSharedApp)=0
Share the specified application.
virtual SDKError ShowSharingAppSelectWnd()=0
A dialog box pops up that enable the user to choose the application or window to share.
virtual SDKError SwitchToShareNextCamera()=0
switch to next camera, when you are sharing the camera.
virtual bool IsShareAppValid(HWND hwndSharedApp)=0
Determine if the window handle can be shared.If the hwndSharedApp is nullptr, the return value is FAL...
virtual IList< ZoomSDKSharingSourceInfo > * GetSharingSourceInfoList(unsigned int userID)=0
Get the sharing source information list from the specified sharer.
virtual bool IsWhiteboardLegalNoticeAvailable()=0
Determine whether the legal notice for white board is available.
virtual SDKError ResumeCurrentSharing()=0
Resume the current sharing.
virtual SDKError EnableShareComputerSound(bool bEnable)=0
Enable or disable the computer audio before sharing.
virtual SDKError StopShare()=0
Stop the current sharing.
virtual SDKError StartSharePureComputerAudio()=0
Start sharing only the computer audio.
virtual bool IsCurrentSharingSupportShareWithComputerSound()=0
Determine if the current share supports sharing with compute sound or not.
virtual SDKError IsShareLocked(bool &bLocked)=0
Determine if the sharing is locked.
virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool bEnable)=0
Enable follow presenter's pointer by the function when watching the share on the specified view.
virtual bool CanStartShare(CannotShareReasonType &reason)=0
Determine whether the current meeting can start sharing.
virtual bool IsEnableOptimizeForFullScreenVideoClipOn()=0
virtual const zchar_t * getWhiteboardLegalNoticesPrompt()=0
Get the white board legal notices prompt.
virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool &bCan)=0
Determine if the follow presenter's pointer can be enabled when watching the share on the specified v...
virtual SDKError StartMonitorShare(const zchar_t *monitorID)=0
Share the specified monitor.
virtual bool IsSupportEnableOptimizeForFullScreenVideoClip()=0
virtual SDKError StartShareFrame()=0
Start sharing frame.
virtual SDKError ShowShareOptionDialog()=0
Display the dialog of sharing configuration.
virtual SDKError StartVideoFileShare(const zchar_t *filePath)=0
Share the video file.
virtual SDKError EnableShareToBO(bool bEnable)=0
Set to enable sharing to the breakout room.
virtual SDKError SwitchToFitWindowModeWhenViewShare(SDKViewType type)=0
Switch to auto-adjust mode from sharing window by the function when watching the share on the specifi...
virtual bool CanStartShare()=0
Determine if it is able to share.
virtual SDKError GetAudioShareMode(AudioShareMode &mode)=0
Get the audio share mode.
virtual SDKError SetAudioShareMode(AudioShareMode mode)=0
Set the audio share mode before or during sharing.
virtual bool IsDesktopSharingEnabled()=0
Determine if it is able to share desktop in the current meeting.
virtual IList< unsigned int > * GetViewableSharingUserList()=0
Get the ID of users who are sharing.
virtual SDKError CanSwitchToShareNextCamera(bool &bCan)=0
Determine whether can switch to next camera, when share camera.
virtual SDKError StartShareCamera(const zchar_t *deviceID, HWND hWnd)=0
Start sharing camera.
virtual SDKError CanEnableShareToBO(bool &bCan)=0
Determine whether the user can share to the breakout room.
virtual bool IsEnableShareComputerSoundOn()=0
virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio)=0
Switch the window size by the function when watching the share on the specified view.
virtual SDKError EnableOptimizeForFullScreenVideoClipWhenSharing(bool bEnable)=0
Enable or disable the video optimization when sharing.
virtual SDKError GetMultiShareSettingOptions(MultiShareOption &shareOption)=0
Get the options for multi-participants share.
virtual bool IsEnableOptimizeForFullScreenVideoClipOnWhenSharing()=0
virtual SDKError StartAirPlayShare()=0
Start sharing with mobile device.
virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable)=0
Enable or disable the video optimization before sharing.
virtual SDKError IsShareToBOEnabled(bool &bEnabled)=0
Determine if sharing to the breakout room is enabled.
virtual bool IsSupportEnableShareComputerSound(bool &bCurEnableOrNot)=0
Determine if the sound of the computer in the current sharing or before share is supported.
virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool &bCurEnableOrNot)=0
Determine whether to optimize the video fluidity when sharing in full screen mode.
virtual bool IsSupportShareWithComputerSound(ShareType type)=0
Determine if the specified share type supports sharing with compute sound or not.
virtual SDKError LockShare(bool isLock)=0
host / co - host can use this function to lock current meeting share.
Callback event of meeting share controller.
virtual void onShareSettingTypeChangedNotification(ShareSettingType type)=0
Callback event of sharing setting type changed.
virtual void onSharedVideoEnded()=0
Callback event of the shared video's playback has completed.
virtual void onShareContentNotification(ZoomSDKSharingSourceInfo shareInfo)=0
Callback event of changed sharing information.
virtual void onMultiShareSwitchToSingleShareNeedConfirm(IShareSwitchMultiToSingleConfirmHandler *handler_)=0
Callback event of switching multi-participants share to one participant share.
virtual void onFailedToStartShare()=0
Callback event of failure to start sharing.
virtual void onSharingStatus(ZoomSDKSharingSourceInfo shareInfo)=0
Callback event of the changed sharing status.
virtual void onLockShareStatus(bool bLocked)=0
Callback event of locked share status.
virtual void onVideoFileSharePlayError(ZoomSDKVideoFileSharePlayError error)=0
Callback event of the video file playback error.
virtual void onOptimizingShareForVideoClipStatusChanged(ZoomSDKSharingSourceInfo shareInfo)=0
Callback event of the changed optimizing video status.
Reminder handler of switching from multi-share to single share.
virtual SDKError Cancel()=0
Cancel to switch multi-share to single share. All sharing will be remained.
virtual SDKError Confirm()=0
Switch multi-share to single share. All sharing will be stopped.
SDKViewType
SDK View Type, primary displayer and secondary displayer. Here are more detailed structural descripti...
SDKShareViewZoomRatio
Share view zoom ratio. Here are more detailed structural descriptions.
@ AdvanceShareOption_ShareCamera
Type of sharing the camera.
@ AdvanceShareOption_ShareFrame
Type of sharing a selected area of desktop.
@ AdvanceShareOption_PureComputerAudio
Type of sharing only the computer audio.
ShareSettingType
Share setting type. Here are more detailed structural descriptions..
@ ShareSettingType_LOCK_SHARE
Only host can share, the same as "lock share".
@ ShareSettingType_ANYONE_GRAB
Anyone can share, but one sharing only at one moment, and anyone can grab other's sharing.
@ ShareSettingType_MULTI_SHARE
Anyone can share, Multi-share can exist at the same time.
@ ShareSettingType_HOST_GRAB
Anyone can share, but one sharing only at one moment, and only host can grab other's sharing.
@ Enable_Multi_Share
Multi-participants can share simultaneously.
@ Enable_Only_HOST_Grab_Share
One participant can share at a time, during sharing only host can start a new sharing and the previou...
@ Enable_All_Grab_Share
One participant can share at a time, during sharing everyone can start a new sharing and the previous...
@ Enable_Only_HOST_Start_Share
Only host can share at a time.
struct tagZoomSDKSharingSourceInfo ZoomSDKSharingSourceInfo
ZoomSDKVideoFileSharePlayError
@ ZoomSDKVideoFileSharePlayError_Open_Fail
Failed to open.
@ ZoomSDKVideoFileSharePlayError_Resolution_Too_High
The resolution is too high to play.
@ ZoomSDKVideoFileSharePlayError_None
@ ZoomSDKVideoFileSharePlayError_Seek_Fail
Failed to seek.
@ ZoomSDKVideoFileSharePlayError_Not_Supported
Not supported.
@ ZoomSDKVideoFileSharePlayError_Play_Fail
Failed to play.
AudioShareMode
Audio share mode. Here are more detailed structural descriptions.
@ AudioShareMode_Mono
Mono mode.
@ AudioShareMode_Stereo
Stereo mode.
Visible shared source information. Here are more detailed structural descriptions....
unsigned int shareSourceID
Share source ID.
SharingStatus status
The values of sharing status, see SharingStatus enum.
ShareType contentType
Type of sharing, see ShareType enum.
bool isShowingInSecondView
Display or not on the secondary view. Available only for Zoom UI mode.
bool isShowingInFirstView
Display or not on the primary view. Available only for Zoom UI mode.
bool isCanBeRemoteControl
Enable or disable the remote control.
bool bEnableOptimizingVideoSharing
Enable or disable the optimizing video.
const zchar_t * monitorID
The ID of screen to be shared. It is invalid unless the value of the eShareType is SHARE_TYPE_DS.
HWND hwndSharedApp
Handle of sharing application or white-board. It is invalid unless the value of the eShareType is SHA...
ZOOM windows SDK Common Definition File.
CannotShareReasonType
Enumeration of reasons why sharing is not allowed.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
ShareType
Enumeration of types of shared content.
@ SHARE_TYPE_UNKNOWN
SDKError
Enumeration of common errors of SDK.
SharingStatus
Enumeration of sharing status.
@ Sharing_Self_Send_Begin