Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_sharing_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_SHARING_INTERFACE_H_
6#define _MEETING_SHARING_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
26
38
81
95
107
122
128{
129public:
133 virtual SDKError Cancel() = 0;
134
138 virtual SDKError Confirm() = 0;
139
141};
142
148{
149public:
151
157 virtual void onSharingStatus(ZoomSDKSharingSourceInfo shareInfo) = 0;
158
162 virtual void onFailedToStartShare() = 0;
163
169 virtual void onLockShareStatus(bool bLocked) = 0;
170
176
182
188
192 virtual void onSharedVideoEnded() = 0;
193
199
205};
206
212{
213public:
220
221#if defined(WIN32)
228 virtual SDKError StartAppShare(HWND hwndSharedApp) = 0;
229
235 virtual bool IsShareAppValid(HWND hwndSharedApp) = 0;
236
244 virtual SDKError StartMonitorShare(const zchar_t* monitorID) = 0;
245
251 virtual SDKError ShowSharingAppSelectWnd() = 0;
252
258 virtual SDKError StartAirPlayShare() = 0;
259
265 virtual SDKError StartShareCamera() = 0;
266
280 virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
281
288 virtual SDKError SwitchToFitWindowModeWhenViewShare(SDKViewType type) = 0;
289
296 virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio) = 0;
297
304 virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool bEnable) = 0;
305
312 virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool& bCan) = 0;
313
322 virtual SDKError ViewShare(unsigned int shareSourceID, SDKViewType type) = 0;
323
330 virtual SDKError StartWhiteBoardShare() = 0;
331
337 virtual SDKError StartShareFrame() = 0;
338
344 virtual SDKError StartSharePureComputerAudio() = 0;
350 virtual SDKError StartShareCamera(const zchar_t* deviceID, HWND hWnd) = 0;
351
357 virtual SDKError ShowShareOptionDialog() = 0;
358#endif
359
367
373 virtual SDKError StopShare() = 0;
374
381 virtual SDKError LockShare(bool isLock) = 0;
382
389
396
403
412
419 virtual bool CanStartShare() = 0;
420
426 virtual bool CanStartShare(CannotShareReasonType& reason) = 0;
427
433 virtual bool IsDesktopSharingEnabled() = 0;
434
441 virtual SDKError IsShareLocked(bool& bLocked) = 0;
442
450 virtual bool IsSupportEnableShareComputerSound(bool& bCurEnableOrNot) = 0;
451
459 virtual bool IsSupportEnableOptimizeForFullScreenVideoClip(bool& bCurEnableOrNot) = 0;
460
467
473
479
486 virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
487
493
501
509
517
523
529
537
543
551
558
565
571 virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
572
578
583 virtual bool CanShareVideoFile() = 0;
584
585#if defined(WIN32)
591 virtual SDKError CanEnableShareToBO(bool& bCan) = 0;
592
599 virtual SDKError EnableShareToBO(bool bEnable) = 0;
600
607 virtual SDKError IsShareToBOEnabled(bool& bEnabled) = 0;
608
614 virtual SDKError StartVideoFileShare(const zchar_t* filePath) = 0;
615
620 virtual bool IsWhiteboardLegalNoticeAvailable() = 0;
621
625 virtual const zchar_t* getWhiteboardLegalNoticesPrompt() = 0;
626
630 virtual const zchar_t* getWhiteboardLegalNoticesExplained() = 0;
631#endif
632};
634#endif
Meeting share controller interface.
virtual bool IsEnableShareComputerSoundOnWhenSharing()=0
Determine if the current sharing content enabled sharing with compute sound or not.
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 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
Enable or disable the computer audio before sharing.
virtual SDKError StopShare()=0
Stop the current sharing.
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 bool CanStartShare(CannotShareReasonType &reason)=0
Determine whether the current meeting can start sharing.
virtual bool IsEnableOptimizeForFullScreenVideoClipOn()=0
Determine if the current meeting enabled sharing with optimize video or not.
virtual bool IsSupportEnableOptimizeForFullScreenVideoClip()=0
Determine if the current meeting supports sharing with optimize video or not.
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 bool IsEnableShareComputerSoundOn()=0
Determine if the current meeting enabled sharing with compute sound or not before sharing.
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
Determine if the current sharing content enabled sharing with optimize video or not.
virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable)=0
Enable or disable 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 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.
AdvanceShareOption
Additional type of current sharing sent to others. Here are more detailed structural descriptions.
@ AdvanceShareOption_ShareCamera
@ AdvanceShareOption_ShareFrame
@ AdvanceShareOption_PureComputerAudio
ShareSettingType
Share setting type. Here are more detailed structural descriptions..
@ ShareSettingType_LOCK_SHARE
@ ShareSettingType_ANYONE_GRAB
@ ShareSettingType_MULTI_SHARE
@ ShareSettingType_HOST_GRAB
@ Enable_Only_HOST_Grab_Share
@ Enable_Only_HOST_Start_Share
struct tagZoomSDKSharingSourceInfo ZoomSDKSharingSourceInfo
Visible shared source information. Here are more detailed structural descriptions....
ZoomSDKVideoFileSharePlayError
@ ZoomSDKVideoFileSharePlayError_Open_Fail
@ ZoomSDKVideoFileSharePlayError_Resolution_Too_High
@ ZoomSDKVideoFileSharePlayError_None
@ ZoomSDKVideoFileSharePlayError_Seek_Fail
@ ZoomSDKVideoFileSharePlayError_Not_Supported
@ ZoomSDKVideoFileSharePlayError_Play_Fail
AudioShareMode
Audio share mode. Here are more detailed structural descriptions.
@ AudioShareMode_Stereo
Visible shared source information. Here are more detailed structural descriptions....
ZOOM windows SDK Common Definition File.
CannotShareReasonType
Enumeration of reasons why sharing is not allowed.
void * HWND
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
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