Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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
188 virtual SDKError ShowSharingAppSelectWnd() = 0;
189
194 virtual SDKError StartAirPlayShare() = 0;
195
200 virtual SDKError StartShareCamera() = 0;
201
214 virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
215
221 virtual SDKError SwitchToFitWindowModeWhenViewShare(SDKViewType type) = 0;
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
258 virtual SDKError StartWhiteBoardShare() = 0;
259
264 virtual SDKError StartShareFrame() = 0;
265
270 virtual SDKError StartSharePureComputerAudio() = 0;
271
276 virtual SDKError StartShareCamera(const zchar_t* deviceID, HWND hWnd) = 0;
277
282 virtual SDKError ShowShareOptionDialog() = 0;
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
357 virtual bool IsSupportEnableShareComputerSound(bool& bCurEnableOrNot) = 0;
358
363 virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool& bCurEnableOrNot) = 0;
364
370 virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
371
378
385
392
399
406
412
418
423 virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
424
429
432 virtual bool CanShareVideoFile() = 0;
433
434#if defined(WIN32)
439 virtual SDKError CanEnableShareToBO(bool& bCan) = 0;
440
446 virtual SDKError EnableShareToBO(bool bEnable) = 0;
447
453 virtual SDKError IsShareToBOEnabled(bool& bEnabled) = 0;
454
459 virtual SDKError StartVideoFileShare(const zchar_t* filePath) = 0;
460
461
464 virtual bool IsWhiteboardLegalNoticeAvailable() = 0;
465
467 virtual const zchar_t* getWhiteboardLegalNoticesPrompt() = 0;
468
470 virtual const zchar_t* getWhiteboardLegalNoticesExplained() = 0;
471#endif
472};
474#endif
Meeting share controller interface.
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 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 SetEvent(IMeetingShareCtrlEvent *pEvent)=0
Set meeting share controller callback event handler.
virtual SDKError SwitchToShareNextCamera()=0
switch to next camera, when you are sharing the camera.
virtual IList< ZoomSDKSharingSourceInfo > * GetSharingSourceInfoList(unsigned int userID)=0
Get the sharing source information list from the specified sharer.
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 StopShare()=0
Stop the current sharing.
virtual SDKError IsShareLocked(bool &bLocked)=0
Determine if the sharing is locked.
virtual bool CanStartShare(CannotShareReasonType &reason)=0
Determine whether the current meeting can start sharing.
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 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 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.
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.
@ 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
void * HWND
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
ShareType
@ SHARE_TYPE_UNKNOWN
Type unknown.
SDKError
SDK error types. Here are more detailed structural descriptions.
SharingStatus
Sharing status. Here are more detailed structural descriptions..
@ Sharing_Self_Send_Begin
Begin to share by the user himself.