meeting_sharing_interface.h

Go to the documentation of this file.

#ifndef _MEETING_SHARING_INTERFACE_H_
#define _MEETING_SHARING_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE
enum ShareSettingType
{
    ShareSettingType_LOCK_SHARE,
    ShareSettingType_HOST_GRAB, 
    ShareSettingType_ANYONE_GRAB,  
    ShareSettingType_MULTI_SHARE,  
    
};

enum AudioShareMode
{
    AudioShareMode_Mono,        
    AudioShareMode_Stereo       
};

typedef struct tagZoomSDKSharingSourceInfo
{
    unsigned int userid;            
    unsigned int shareSourceID;     
    SharingStatus status;           
    bool isShowingInFirstView;      
    bool isShowingInSecondView;     
    bool isCanBeRemoteControl;      
    bool bEnableOptimizingVideoSharing;    

    ShareType contentType;          
    HWND hwndSharedApp;             
    const zchar_t* monitorID;       
 
    tagZoomSDKSharingSourceInfo()
    {
        userid = 0;
        shareSourceID = 0;
        contentType = SHARE_TYPE_UNKNOWN;
        status = Sharing_Self_Send_Begin;
        isShowingInFirstView = false;
        isShowingInSecondView = false;
        isCanBeRemoteControl = false;
        bEnableOptimizingVideoSharing = false;
        hwndSharedApp = nullptr;
        monitorID = nullptr;
    }
}ZoomSDKSharingSourceInfo;

enum AdvanceShareOption
{
    AdvanceShareOption_ShareFrame,
    AdvanceShareOption_PureComputerAudio,
    AdvanceShareOption_ShareCamera,
};
 
enum MultiShareOption
{
    Enable_Multi_Share = 0, 
    Enable_Only_HOST_Start_Share, 
    Enable_Only_HOST_Grab_Share, 
    Enable_All_Grab_Share, 
};
 
enum ZoomSDKVideoFileSharePlayError
{
    ZoomSDKVideoFileSharePlayError_None,
    ZoomSDKVideoFileSharePlayError_Not_Supported,
    ZoomSDKVideoFileSharePlayError_Resolution_Too_High,
    ZoomSDKVideoFileSharePlayError_Open_Fail,
    ZoomSDKVideoFileSharePlayError_Play_Fail,
    ZoomSDKVideoFileSharePlayError_Seek_Fail
};
 
#if defined(WIN32)
enum ZoomSDKVideoSharingQuality
{
    ZoomSDKVideoSharingQuality_None,

    ZoomSDKVideoSharingQuality_720p_30fps,

    ZoomSDKVideoSharingQuality_720p_60fps,

    ZoomSDKVideoSharingQuality_1080p_30fps,

    ZoomSDKVideoSharingQuality_1080p_60fps,
};
#endif

class IShareSwitchMultiToSingleConfirmHandler
{
public:
    virtual SDKError Cancel() = 0;
    
    virtual SDKError Confirm() = 0;
 
    virtual ~IShareSwitchMultiToSingleConfirmHandler() {};
};

struct ZoomSDKAnnotationArrowInfo
{
    int posX;
    int posY;
    const zchar_t* pTitle;
    unsigned int arrowColor;
    unsigned int titleColor;
    unsigned short alpha;
 
    ZoomSDKAnnotationArrowInfo()
    {
        posX = 0;
        posY = 0;
        pTitle = nullptr;
        arrowColor = 0;
        titleColor = 0;
        alpha = 0;
    }
};
 
enum ZoomSDKRemoteControlMouseEventType
{
    ZoomSDKRemoteControlMouseEventType_Move,
    ZoomSDKRemoteControlMouseEventType_Left_Down,
    ZoomSDKRemoteControlMouseEventType_Left_Up
};

struct ZoomSDKRemoteControlMouseInfo
{
    ZoomSDKRemoteControlMouseEventType eventType;
    int x;
    int y;
};

class IMeetingShareCtrlEvent
{
public:
    virtual ~IMeetingShareCtrlEvent() {}
    
    virtual void onSharingStatus(ZoomSDKSharingSourceInfo shareInfo) = 0;
    
    virtual void onFailedToStartShare() = 0;
    
    virtual void onShareContentNotification(ZoomSDKSharingSourceInfo shareInfo) = 0;
    
    virtual void onMultiShareSwitchToSingleShareNeedConfirm(IShareSwitchMultiToSingleConfirmHandler* handler_) = 0;
    
    virtual void onShareSettingTypeChangedNotification(ShareSettingType type) = 0;
    
    virtual void onSharedVideoEnded() = 0;
    
    virtual void onVideoFileSharePlayError(ZoomSDKVideoFileSharePlayError error) = 0;
    
    virtual void onOptimizingShareForVideoClipStatusChanged(ZoomSDKSharingSourceInfo shareInfo) = 0;
 
#if defined(WIN32)
    virtual void onVideoSharingQualityChanged(ZoomSDKVideoSharingQuality quality) = 0;
#endif

    virtual void onAnnotationArrowInfoChanged(const ZoomSDKAnnotationArrowInfo& arrowInfo) {}

    virtual void onRemoteControlMouseInfoChanged(const ZoomSDKRemoteControlMouseInfo& mouseInfo) {}
};

class IMeetingShareController
{
public:
    virtual SDKError SetEvent(IMeetingShareCtrlEvent* pEvent) = 0;
    
    virtual SDKError StartAppShare(HWND hwndSharedApp) = 0;
    
    virtual SDKError StartMonitorShare(const zchar_t* monitorID) = 0;
#if defined(WIN32)
    virtual bool IsShareAppValid(HWND hwndSharedApp) = 0;
    virtual SDKError ShowSharingAppSelectWnd() = 0;
    
    virtual SDKError StartAirPlayShare() = 0;
    
    virtual SDKError StartShareCamera() = 0;
    
    virtual SDKError BlockWindowFromScreenshare(bool bBlock, HWND hWnd, bool bChangeWindowStyle = true) = 0;
    
    virtual SDKError SwitchToFitWindowModeWhenViewShare(SDKViewType type) = 0;
    
    virtual SDKError SwitchZoomRatioWhenViewShare(unsigned int shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio) = 0;
    
    virtual SDKError EnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool bEnable) = 0;
    
    virtual SDKError CanEnableFollowPresenterPointerWhenViewShare(unsigned int shareSourceID, bool& bCan) = 0;
    
    virtual SDKError StartWhiteBoardShare() = 0;
    
    virtual SDKError StartShareFrame() = 0;
    
    virtual SDKError StartSharePureComputerAudio() = 0;
    virtual SDKError StartShareCamera(const zchar_t* deviceID, HWND hWnd) = 0;
    
    virtual SDKError ShowShareOptionDialog() = 0;
#endif

    virtual SDKError IsSupportAdvanceShareOption(AdvanceShareOption option_) = 0;
    
    virtual SDKError StopShare() = 0;
    
    virtual SDKError PauseCurrentSharing() = 0;
    
    virtual SDKError ResumeCurrentSharing() = 0;
    
    virtual IList<unsigned int>* GetViewableSharingUserList() = 0;
    
    virtual IList<ZoomSDKSharingSourceInfo>* GetSharingSourceInfoList(unsigned int userID) = 0;
    
    virtual bool CanStartShare(CannotShareReasonType& reason) = 0;
    
    virtual bool IsDesktopSharingEnabled() = 0;
    
    virtual SDKError IsShareLocked(bool& bLocked) = 0;
    
    virtual bool IsSupportShareWithComputerSound(ShareType type) = 0;
    
    virtual bool IsCurrentSharingSupportShareWithComputerSound() = 0;
    
    virtual bool IsEnableShareComputerSoundOn() = 0;
    
    virtual SDKError EnableShareComputerSound(bool bEnable) = 0;
    
    virtual bool IsEnableShareComputerSoundOnWhenSharing() = 0;
    
    virtual SDKError EnableShareComputerSoundWhenSharing(bool bEnable) = 0;
    
    virtual SDKError SetAudioShareMode(AudioShareMode mode) = 0;
    
    virtual SDKError GetAudioShareMode(AudioShareMode& mode) = 0;
    
    virtual bool IsSupportEnableOptimizeForFullScreenVideoClip() = 0;
    
    virtual bool IsEnableOptimizeForFullScreenVideoClipOn() = 0;
    
    virtual SDKError EnableOptimizeForFullScreenVideoClip(bool bEnable) = 0;
    
    virtual bool IsEnableOptimizeForFullScreenVideoClipOnWhenSharing() = 0;
    
    virtual SDKError EnableOptimizeForFullScreenVideoClipWhenSharing(bool bEnable) = 0;
    
    virtual SDKError SetMultiShareSettingOptions(MultiShareOption shareOption) = 0;
    
    virtual SDKError GetMultiShareSettingOptions(MultiShareOption& shareOption) = 0;
 
#if defined(WIN32)
    virtual bool CanSetVideoSharingQuality(ZoomSDKVideoSharingQuality quality, ShareType shareType) = 0;

    virtual SDKError SetVideoSharingQuality(ZoomSDKVideoSharingQuality quality) = 0;

    virtual ZoomSDKVideoSharingQuality GetVideoSharingQuality() = 0;
#endif

    virtual SDKError CanSwitchToShareNextCamera(bool& bCan) = 0;
    
    virtual SDKError SwitchToShareNextCamera() = 0;
    
    virtual bool CanShareVideoFile() = 0;
 
#if defined(WIN32)
    virtual SDKError CanEnableShareToBO(bool& bCan) = 0;
    
    virtual SDKError EnableShareToBO(bool bEnable) = 0;
    
    virtual SDKError IsShareToBOEnabled(bool& bEnabled) = 0;
    
    virtual SDKError StartVideoFileShare(const zchar_t* filePath) = 0;

    virtual bool IsWhiteboardLegalNoticeAvailable() = 0;
    
    virtual const zchar_t* getWhiteboardLegalNoticesPrompt() = 0;
    
    virtual const zchar_t* getWhiteboardLegalNoticesExplained() = 0;
#endif
};
END_ZOOM_SDK_NAMESPACE
#endif