ZOOM Windows SDK  5.2.42037.1112
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 
10 BEGIN_ZOOM_SDK_NAMESPACE
16 {
24 };
25 
30 typedef struct tagViewableShareSource
31 {
32  unsigned int userid;
37  {
38  userid = 0;
39  isShowingInFirstView = false;
40  isShowingInSecondView = false;
41  isCanBeRemoteControl = false;
42  }
44 
50 {
58 };
64 {
68 };
74 {
79 };
80 
81 typedef struct tagShareInfo
82 {
84  union
85  {
87  const wchar_t* monitorID;
88  }ut;
89  tagShareInfo()
90  {
92  memset(&ut, 0, sizeof(ut));
93  }
94 }ShareInfo;
95 
99 {
100 public:
102  virtual SDKError Cancel() = 0;
103 
105  virtual SDKError Confirm() = 0;
106 
108 };
109 
113 {
114 public:
119  virtual void onSharingStatus(SharingStatus status, unsigned int userId) = 0;
120 
123  virtual void onLockShareStatus(bool bLocked) = 0;
124 
127  virtual void onShareContentNotification(ShareInfo& shareInfo) = 0;
128 
132 };
133 
137 {
138 public:
143  virtual SDKError SetEvent(IMeetingShareCtrlEvent* pEvent) = 0;
144 
150  virtual SDKError StartAppShare(HWND hwndSharedApp) = 0;
151 
157  virtual SDKError StartMonitorShare(const wchar_t* monitorID) = 0;
158 
163  virtual SDKError StartAirPlayShare() = 0;
164 
170  virtual SDKError StartWhiteBoardShare() = 0;
171 
176  virtual SDKError ShowSharingAppSelectWnd() = 0;
177 
184 
189  virtual SDKError StartShareFrame() = 0;
190 
196 
201  virtual SDKError StartShareCamera() = 0;
202 
207  virtual SDKError StopShare() = 0;
208 
221  virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
222 
228  virtual SDKError LockShare() = 0;
229 
235  virtual SDKError UnlockShare() = 0;
236 
243 
250 
255  virtual SDKError PauseCurrentSharing() = 0;
256 
261  virtual SDKError ResumeCurrentSharing() = 0;
262 
268 
275  virtual SDKError GetViewabltShareSourceByUserID(unsigned int userid, ViewableShareSource& shareSource) = 0;
276 
283  virtual SDKError ViewShare(unsigned int userid, SDKViewType type) = 0;
284 
289  virtual SDKError ShowShareOptionDialog() = 0;
290 
294  virtual bool CanStartShare() = 0;
295 
301  virtual SDKError IsShareLocked(bool& bLocked) = 0;
302 
307  virtual bool IsSupportEnableShareComputerSound(bool& bCurEnableOrNot) = 0;
308 
313  virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool& bCurEnableOrNot) = 0;
314 
320  virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
321 
327  virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable) = 0;
328 
333  virtual SDKError SetMultiShareSettingOptions(MultiShareOption shareOption) = 0;
334 
339  virtual SDKError GetMultiShareSettingOptions(MultiShareOption& shareOption) = 0;
340 
345  virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
346 
350  virtual SDKError SwitchToShareNextCamera() = 0;
351 };
352 END_ZOOM_SDK_NAMESPACE
353 #endif
Others begin to share.
Definition: meeting_sharing_interface.h:19
virtual bool CanStartShare()=0
Determine if it is able to share.
virtual SDKError SetEvent(IMeetingShareCtrlEvent *pEvent)=0
Set meeting share controller callback event handler.
virtual SDKError UnlockShare()=0
Unlock the current meeting sharing.
virtual SDKError ResumeCurrentSharing()=0
Resume the current sharing.
virtual SDKError StartWhiteBoardShare()=0
Start sharing with White board.
Type of sharing the data.
Definition: meeting_sharing_interface.h:57
virtual SDKError SwitchToOriginalSizeModeWhenViewShare(SDKViewType type)=0
Switch the window size to originality by the function when watching the share on the specified view...
ShareType eShareType
Type of sharing, see ShareType enum.
Definition: meeting_sharing_interface.h:83
Type of sharing the white-board.
Definition: meeting_sharing_interface.h:54
virtual SDKError SwitchToShareNextCamera()=0
switch to next camera, when you are sharing the camera.
Resume sharing.
Definition: meeting_sharing_interface.h:23
Type of sharing a selected area of desktop.
Definition: meeting_sharing_interface.h:65
virtual bool IsSupportEnableShareComputerSound(bool &bCurEnableOrNot)=0
Determine if the sound of the computer in the current sharing is supported.
Definition: zoom_sdk_def.h:288
virtual SDKError StartAppShare(HWND hwndSharedApp)=0
Share the specified application.
virtual SDKError CanSwitchToShareNextCamera(bool &bCan)=0
Determine whether can switch to next camera, when share camera.
One participant can share at a time, during sharing only host can start a new sharing and the previou...
Definition: meeting_sharing_interface.h:77
Pause sharing.
Definition: meeting_sharing_interface.h:22
virtual SDKError GetMultiShareSettingOptions(MultiShareOption &shareOption)=0
Get the options for multi-participants share.
virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable)=0
Set to enable the video optimization when sharing.
virtual SDKError StartAirPlayShare()=0
Start sharing with mobile device.
One participant can share at a time, during sharing everyone can start a new sharing and the previous...
Definition: meeting_sharing_interface.h:78
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual SDKError Cancel()=0
Cancel to switch multi-share to single share. All sharing will be remained.
Stop sharing by the user.
Definition: meeting_sharing_interface.h:18
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 IList< unsigned int > * GetViewableShareSourceList()=0
Get the list of all the sharers in the current meeting.
Type of sharing the application.
Definition: meeting_sharing_interface.h:52
virtual void onLockShareStatus(bool bLocked)=0
Callback event of locked share status.
virtual SDKError ShowSharingAppSelectWnd()=0
A dialog box pops up that enable the user to choose the application or window to share.
virtual SDKError StartShareCamera()=0
Start sharing camera.
HWND hwndSharedApp
Handle of sharing application or white-board. It is invalid unless the value of the eShareType is SHA...
Definition: meeting_sharing_interface.h:86
virtual SDKError GetViewabltShareSourceByUserID(unsigned int userid, ViewableShareSource &shareSource)=0
Get the sharing information from the specified sharer.
Visible shared source information. Here are more detailed structural descriptions..
Definition: meeting_sharing_interface.h:30
virtual SDKError IsSupportAdvanceShareOption(AdvanceShareOption option_)=0
Determine if the specified ADVANCE SHARE OPTION is supported.
Begin to share by the user himself.
Definition: meeting_sharing_interface.h:17
bool isShowingInFirstView
Display or not on the primary view.
Definition: meeting_sharing_interface.h:33
Reminder handler of switching from multi-share to single share.
Definition: meeting_sharing_interface.h:98
Type of sharing the desktop.
Definition: meeting_sharing_interface.h:53
Type unknown.
Definition: meeting_sharing_interface.h:51
Type of sharing data from the device connected WIFI.
Definition: meeting_sharing_interface.h:55
virtual SDKError ViewShare(unsigned int userid, SDKViewType type)=0
View the share from the specified user.
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 void onShareContentNotification(ShareInfo &shareInfo)=0
Callback event of changed sharing information.
SDKViewType
SDK View Type, primary displayer and secondary displayer. Here are more detailed structural descripti...
Definition: meeting_service_interface.h:268
Callback event of meeting share controller.
Definition: meeting_sharing_interface.h:112
virtual void onMultiShareSwitchToSingleShareNeedConfirm(IShareSwitchMultiToSingleConfirmHandler *handler_)=0
Callback event of switching multi-participants share to one participant share.
AdvanceShareOption
Definition: meeting_sharing_interface.h:63
virtual SDKError StopShare()=0
Stop the current sharing.
bool isCanBeRemoteControl
Enable or disable the remote control.
Definition: meeting_sharing_interface.h:35
Type of sharing only the computer audio.
Definition: meeting_sharing_interface.h:66
const wchar_t * monitorID
The ID of screen to be shared. It is invalid unless the value of the eShareType is SHARE_TYPE_DS...
Definition: meeting_sharing_interface.h:87
View the sharing of others.
Definition: meeting_sharing_interface.h:21
virtual SDKError PauseCurrentSharing()=0
Pause the current sharing.
virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool &bCurEnableOrNot)=0
Determine whether to optimize the video fluidity when sharing in full screen mode.
virtual SDKError StartShareFrame()=0
Start sharing frame.
unsigned int userid
User ID.
Definition: meeting_sharing_interface.h:32
virtual SDKError StartSharePureComputerAudio()=0
Start sharing only the computer audio.
virtual SDKError Confirm()=0
Switch multi-share to single share. All sharing will be remained.
ShareType
Definition: meeting_sharing_interface.h:49
Meeting share controller interface.
Definition: meeting_sharing_interface.h:136
virtual SDKError EnableShareComputerSound(bool bEnable)=0
Set to enable or disable the audio when sharing.
Others stop sharing.
Definition: meeting_sharing_interface.h:20
bool isShowingInSecondView
Display or not on the secondary view.
Definition: meeting_sharing_interface.h:34
Multi-participants can share simultaneously.
Definition: meeting_sharing_interface.h:75
virtual SDKError SetMultiShareSettingOptions(MultiShareOption shareOption)=0
Set the options for multi-participants share.
Type of sharing the camera.
Definition: meeting_sharing_interface.h:67
MultiShareOption
Definition: meeting_sharing_interface.h:73
SharingStatus
Sharing status. Here are more detailed structural descriptions..
Definition: meeting_sharing_interface.h:15
virtual SDKError StartMonitorShare(const wchar_t *monitorID)=0
Share the specified monitor.
virtual void onSharingStatus(SharingStatus status, unsigned int userId)=0
Callback event of the changed sharing status.
Type of sharing the camera.
Definition: meeting_sharing_interface.h:56
Only host can share at a time.
Definition: meeting_sharing_interface.h:76
virtual SDKError IsShareLocked(bool &bLocked)=0
Determine if the sharing is locked.
virtual SDKError ShowShareOptionDialog()=0
Display the dialog of sharing configuration.
virtual SDKError LockShare()=0
Lock the current meeting sharing.
Information of current sharing. Here are more detailed structural descriptions.
Definition: meeting_sharing_interface.h:81