Windows SDK 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
16{
28};
34{
39
40};
41
47{
50};
51
57{
58 unsigned int userid;
63 {
64 userid = 0;
68 }
70
76{
80};
86{
91};
92
93typedef struct tagShareInfo
94{
96 union
97 {
99 const wchar_t* monitorID;
102 {
104 memset(&ut, 0, sizeof(ut)); //checked safe
105 }
107
111{
112public:
114 virtual SDKError Cancel() = 0;
115
117 virtual SDKError Confirm() = 0;
118
120};
121
125{
126public:
128
133 virtual void onSharingStatus(SharingStatus status, unsigned int userId) = 0;
134
137 virtual void onLockShareStatus(bool bLocked) = 0;
138
141 virtual void onShareContentNotification(ShareInfo& shareInfo) = 0;
142
146
150};
151
155{
156public:
162
168 virtual SDKError StartAppShare(HWND hwndSharedApp) = 0;
169
175 virtual SDKError StartMonitorShare(const wchar_t* monitorID) = 0;
176
182
189
195
202
208
214
220
225 virtual SDKError StopShare() = 0;
226
239 virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
240
247
255
261 virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int userid, SDKShareViewZoomRatio shareViewZoomRatio) = 0;
262
268 virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int userid, bool bEnable) = 0;
269
275 virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int userid, bool& bCan) = 0;
276
282
288
294
301 virtual SDKError GetViewabltShareSourceByUserID(unsigned int userid, ViewableShareSource& shareSource) = 0;
302
309 virtual SDKError ViewShare(unsigned int userid, SDKViewType type) = 0;
310
316
320 virtual bool CanStartShare() = 0;
321
327 virtual SDKError IsShareLocked(bool& bLocked) = 0;
328
333 virtual bool IsSupportEnableShareComputerSound(bool& bCurEnableOrNot) = 0;
334
339 virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool& bCurEnableOrNot) = 0;
340
346 virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
347
354
361
368
375
382
388
394
399 virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
400
405
409
411 virtual const wchar_t* getWhiteboardLegalNoticesPrompt() = 0;
412
414 virtual const wchar_t* getWhiteboardLegalNoticesExplained() = 0;
415};
417#endif
Meeting share controller interface.
virtual SDKError StartWhiteBoardShare()=0
Start sharing with White board.
virtual SDKError PauseCurrentSharing()=0
Pause the current sharing.
virtual SDKError EnableShareComputerSoundWhenSharing(bool bEnable)=0
Set to enable or disable the 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 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 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 SwitchToOriginalSizeModeWhenViewShare(SDKViewType type)=0
Switch the window size to originality by the function when watching the share on the specified view.
virtual SDKError SwitchToShareNextCamera()=0
switch to next camera, when you are sharing the camera.
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
Set to enable or disable the audio before sharing.
virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int userid, bool &bCan)=0
Determine if the follow presenter's pointer can be enabled when watching the share on the specified v...
virtual SDKError StopShare()=0
Stop the current sharing.
virtual SDKError StartSharePureComputerAudio()=0
Start sharing only the computer audio.
virtual SDKError IsShareLocked(bool &bLocked)=0
Determine if the sharing is locked.
virtual const wchar_t * getWhiteboardLegalNoticesPrompt()=0
Get the white board legal notices prompt.
virtual SDKError GetViewabltShareSourceByUserID(unsigned int userid, ViewableShareSource &shareSource)=0
Get the sharing information from the specified sharer.
virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int userid, bool bEnable)=0
Enable follow presenter's pointer by the function when watching the share on the specified view.
virtual SDKError StartShareFrame()=0
Start sharing frame.
virtual SDKError ShowShareOptionDialog()=0
Display the dialog of sharing configuration.
virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int userid, SDKShareViewZoomRatio shareViewZoomRatio)=0
Switch the window size by the function when watching the share on the specified view.
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 const wchar_t * getWhiteboardLegalNoticesExplained()=0
Get the white board legal notices explained.
virtual bool CanStartShare()=0
Determine if it is able to share.
virtual SDKError StartMonitorShare(const wchar_t *monitorID)=0
Share the specified monitor.
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 IList< unsigned int > * GetViewableShareSourceList()=0
Get the list of all the sharers in the current meeting.
virtual SDKError ViewShare(unsigned int userid, SDKViewType type)=0
View the share from the specified user.
virtual SDKError CanSwitchToShareNextCamera(bool &bCan)=0
Determine whether can switch to next camera, when share camera.
virtual SDKError EnableOptimizeForFullScreenVideoClipWhenSharing(bool bEnable)=0
Set to enable the video optimization when sharing.
virtual SDKError GetMultiShareSettingOptions(MultiShareOption &shareOption)=0
Get the options for multi-participants share.
virtual SDKError StartAirPlayShare()=0
Start sharing with mobile device.
virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable)=0
Set to enable the video optimization before sharing.
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.
Callback event of meeting share controller.
virtual void onShareSettingTypeChangedNotification(ShareSettingType type)=0
Callback event of sharing setting type changed.
virtual void onShareContentNotification(ShareInfo &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 onLockShareStatus(bool bLocked)=0
Callback event of locked share status.
virtual void onSharingStatus(SharingStatus status, unsigned int userId)=0
Callback event of the changed sharing 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 remained.
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.
struct tagShareInfo ShareInfo
@ 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 tagViewableShareSource ViewableShareSource
AudioShareMode
Audio share mode. Here are more detailed structural descriptions.
@ AudioShareMode_Mono
@ AudioShareMode_Stereo
Mono mode.
SharingStatus
Sharing status. Here are more detailed structural descriptions..
@ Sharing_Other_Share_Pure_Audio_Begin
Others begin to share pure audio.
@ Sharing_Self_Send_Begin
Begin to share by the user himself.
@ Sharing_Self_Send_Pure_Audio_End
Stop sharing pure audio by the user.
@ Sharing_View_Other_Sharing
View the sharing of others.
@ Sharing_Self_Send_Pure_Audio_Begin
Begin to share pure audio by the user himself.
@ Sharing_Other_Share_Pure_Audio_End
Others stop sharing pure audio.
@ Sharing_Pause
Pause sharing.
@ Sharing_Resume
Resume sharing.
@ Sharing_Self_Send_End
Stop sharing by the user.
@ Sharing_Other_Share_Begin
Others begin to share.
@ Sharing_Other_Share_End
Others stop sharing.
Information of current sharing. Here are more detailed structural descriptions.
HWND hwndSharedApp
Handle of sharing application or white-board. It is invalid unless the value of the eShareType is SHA...
union tagShareInfo::@1 ut
ShareType eShareType
Type of sharing, see ShareType enum.
const wchar_t * monitorID
The ID of screen to be shared. It is invalid unless the value of the eShareType is SHARE_TYPE_DS.
Visible shared source information. Here are more detailed structural descriptions....
bool isCanBeRemoteControl
Enable or disable the remote control.
bool isShowingInFirstView
Display or not on the primary view.
bool isShowingInSecondView
Display or not on the secondary view.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:21
#define BEGIN_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:20
ShareType
Definition: zoom_sdk_def.h:268
@ SHARE_TYPE_UNKNOWN
Type unknown.
Definition: zoom_sdk_def.h:269
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:30