IMeetingShareHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGSHAREHELPER_H
#define ZRC_IMEETINGSHAREHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum SharingState
{
    SharingStateNone,                  
    SharingStateConnecting,            
    SharingStateSending,               
    SharingStateReceiving,             
    SharingStateSendingAndReceiving    
};
 
enum ZRSharePrivilegeType
{
    ZRSharePrivilegeTypeEnabled = 0,                         
    ZRSharePrivilegeTypeDisabled = 1,                        
    ZRSharePrivilegeTypeDisabledParticipant = 2,             
    ZRSharePrivilegeTypeDisabledWhileOthersSharing = 3,      
    ZRSharePrivilegeTypeDisabledWhileGuestsInMeeting = 4,    
    ZRSharePrivilegeTypeDisabledWhileCloudWhiteboard = 5,    
    ZRSharePrivilegeTypeDisabledInBOWhileMainSessionSharing = 6,    
    ZRSharePrivilegeTypeDisabledStartShareForSimulive = 7,   
    ZRSharePrivilegeTypeDisabledStartShareForDSOnly = 8      
};
 
enum MeetingSharePrivilegeType
{
    MeetingSharePrivilegeTypeUnknown = -1,    
    MeetingSharePrivilegeTypeHostGrab = 0,    
    MeetingSharePrivilegeTypeLockShare,       
    MeetingSharePrivilegeTypeAnyoneGrab,      
    MeetingSharePrivilegeTypeMultiShare       
};
 
enum MeetingShareViewPrivilege
{
    MeetingShareViewPrivilege_FocusModeOff = 0,           
    MeetingShareViewPrivilege_FocusModeHostOnly,          
    MeetingShareViewPrivilege_FocusModeAllParticipants    
};
 
enum HDMI60FPSShareDisableReason
{
    HDMI60FPSShareDisableReasonUnknown = -1,                      
    HDMI60FPSShareDisableReasonNotDisable = 0,                    
    HDMI60FPSShareDisableReasonCaptureCardNotSupport = 1,         
    HDMI60FPSShareDisableReasonZRNotSupport = 2,                  
    HDMI60FPSShareDisableReasonCaptureCardAndZRNotSupport = 3,    
    HDMI60FPSShareDisableReasonOptimizeVideoShareIsOff = 4,       
    HDMI60FPSShareDisableReasonMultiShareIsOn = 5                 
};
 
enum CurrentShareType
{
    CurrentShareTypeUnknown = 0,          
    CurrentShareTypeNormal,               
    CurrentShareTypeCamera,               
    CurrentShareTypeAnnotated,            
    CurrentShareTypeZoomApp,              
    CurrentShareTypeWhiteboard,           
    CurrentShareTypeLocalHDMI,            
    CurrentShareTypeAnnotatedLocalHDMI    
};
 
enum SlideOperationType
{
    SlideOperationTypeLeft = 0,     
    SlideOperationTypeRight         
};
 
enum DocsSharePrivilegeType
{
    DocsSharePrivilegeTypeUnknown = 0,     
    DocsSharePrivilegeTypeHostGrab = 1,    
    DocsSharePrivilegeTypeAnyoneGrab,      
};
 
enum DocsInitiatePrivilegeType
{
    DocsInitiatePrivilegeTypeUnknown = 0,        
    DocsInitiatePrivilegeTypeHostOnly = 1,       
    DocsInitiatePrivilegeTypeInternalUsers,      
    DocsInitiatePrivilegeTypeAllParticipants,    
};
 
struct LocalPresentationInfo
{
    bool        success = false;    
    std::string meetingNumber;      
    std::string meetingPassword;    
};
 
struct SharingStatus
{
    SharingState sharingState = SharingStateNone;    
    bool         canShareToBO = false;               
    bool         isSharingToBO = false;              
};
 
struct ZRWSharingStatus
{
    bool isSharing = false;        
    bool canShareToBO = false;     
    bool isSharingToBO = false;    
};
 
struct ShareSetting
{
    bool                      isMultiShareOn = false;                                
    bool                      isMultiShareDisabled = false;                          
    ZRSharePrivilegeType      zrSharePrivilegeType = ZRSharePrivilegeTypeEnabled;    
    MeetingSharePrivilegeType meetingSharePrivilegeType = MeetingSharePrivilegeTypeUnknown;    
    bool                      isSharePrivilegeSettingLocked = false;    
};
 
struct ShareSource
{
    int32_t         userID = 0;                                  
    int32_t         shareSourceID = 0;                           
    ShareSourceType shareSourceType = ShareSourceTypeUnknown;    
    bool            isSharingAudio = false;                      
    bool            isAudioMuted = false;                        
    ConfInstType    fromType = ConfInstTypeUnknown;              
};
 
struct AirplayBlackMagicStatus
{
    SharingInstructionDisplayState instructionDisplayState = SharingInstructionDisplayStateNone;    
 
    std::string wifiName;                         
    std::string serverName;                       
    std::string password;                         
    std::string directPresentationPairingCode;    
    std::string directPresentationSharingKey;     
 
    bool isAirHostClientConnected = false;               
    bool isBlackMagicConnected = false;                  
    bool isBlackMagicDataAvailable = false;              
    bool isSharingBlackMagic = false;                    
    bool isDirectPresentationConnected = false;          
    bool isBlackMagicSharingLocallyAvailable = false;    
    bool isBlackMagicSharingLocally = false;             
};
 
struct CameraSharingStatus
{
    std::string deviceID;                      
    bool        isSharing = false;             
    bool        isMirrored = false;            
    bool        canBeControlled = false;       
    int32_t     panTiltSpeedPercentage = 0;    
};
 
struct SlideControlInfo
{
    int32_t     userID = 0;           
    std::string userName;             
    int32_t     shareSourceID = 0;    
};
 
struct DocsShareSettingsInfo
{
    bool                      isSupported = false;                                     
    bool                      isAllowParticipantsToShare = false;                      
    DocsSharePrivilegeType    sharePrivilege = DocsSharePrivilegeTypeUnknown;          
    DocsInitiatePrivilegeType initiatePrivilege = DocsInitiatePrivilegeTypeUnknown;    
    bool                      isLocked = false;                                        
};
 
struct ClassicWhiteboardShareStatus
{
    bool    isSharing = false;      
    int32_t shareSourceID = -1;     
};
 
struct IncomingMeetingShareNot
{
    ShareSource      incomingSource;                                
    std::string      shareUserName;                                 
    CurrentShareType currentShareType = CurrentShareTypeUnknown;    
};
 
class IMeetingShareHelperSink
{
public:
    virtual ~IMeetingShareHelperSink() {}
 
    virtual void OnStartLocalPresentNotification(const LocalPresentationInfo& info) = 0;
 
    virtual void OnStartLocalPresentResult(bool isSharingMeeting, SharingInstructionDisplayState displayState) = 0;
 
    virtual void OnSwitchToNormalMeetingResult(int result) = 0;
 
    virtual void OnShowSharingInstructionResult(int result, bool show, SharingInstructionDisplayState instructionState) = 0;
 
    virtual void OnShareSettingNotification(const ShareSetting& setting) = 0;
 
    virtual void OnSharingStatusNotification(const SharingStatus& status) = 0;
 
    virtual void OnUpdateAirPlayBlackMagicStatus(const AirplayBlackMagicStatus& status) = 0;
 
    virtual void OnUpdateCameraSharingStatus(const CameraSharingStatus& status) = 0;
 
    virtual void OnSharingSourceNotification(const std::vector<ShareSource>& zrShareSources, const std::vector<ShareSource>& zrwShareSources) = 0;
 
    virtual void OnHDMI60FPSShareInfoNotification(bool isAllow, bool isOn, HDMI60FPSShareDisableReason disableReason) = 0;
    
    virtual void OnLocalHDMIShareAudioPlaybackNotification(bool isEnabled) = 0;
 
    virtual void OnUpdateClassicWhiteboardShareStatusNotification(const ClassicWhiteboardShareStatus& status) = 0;
 
    virtual void OnZRWSharingStatusNotification(const ZRWSharingStatus& status) = 0;
 
    virtual void OnUpdateLocalViewStatus(bool isOn) = 0;
 
    virtual void OnIncomingMeetingShareNotification(const IncomingMeetingShareNot& noti) = 0;
    
    virtual void OnSlideControlNotification(const std::vector<SlideControlInfo>& slideControlInfos) = 0;
 
    virtual void OnDocsShareSettingsNotification(const DocsShareSettingsInfo& info) = 0;
};
 
class IMeetingShareHelper
{
public:
    virtual ~IMeetingShareHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingShareHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingShareHelperSink* pSink) = 0;
 
    virtual ZRCSDKError LaunchSharingMeeting(bool isInLocalShare, SharingInstructionDisplayState displayState) = 0;
 
    virtual ZRCSDKError SwitchFromLocalPresentationToNormalMeeting() = 0;
 
    virtual ZRCSDKError ShowSharingInstruction(bool show, SharingInstructionDisplayState instructionState) = 0;
 
    virtual ZRCSDKError ShareBlackMagic(bool isStart, bool isViewLocally) = 0;
 
    virtual ZRCSDKError ShareCamera(bool isStart, const std::string& deviceId) = 0;
 
    virtual ZRCSDKError ShareToBreakoutRooms() = 0;
 
    virtual ZRCSDKError StopShareToBreakoutRooms() = 0;
 
    virtual ZRCSDKError StopSharing() = 0;
 
    virtual ZRCSDKError StopZRWSharing() = 0;
 
    virtual ZRCSDKError EnableMultiShare(bool enabled) = 0;
 
    virtual ZRCSDKError ShowPinShareInstruction(bool show) = 0;
 
    virtual ZRCSDKError PinShareOnZRScreen(const ShareSource& shareSource, int32_t screenIndex, bool confirmed) = 0;
 
    virtual ZRCSDKError PinShareOnZRWScreen(const ShareSource& shareSource, int32_t screenIndex) = 0;
    
    virtual ZRCSDKError PinIncomingMeetingShare(const ShareSource& incomingShare, CurrentShareType currentShare, bool pin) = 0;
 
    virtual ZRCSDKError ControlSlide(const SlideControlInfo& slideInfo, SlideOperationType type) = 0;
 
    virtual ZRCSDKError MuteShareAudio(const ShareSource& source, bool mute) = 0;
 
    virtual ZRCSDKError EnableHDMI60FPSShare(bool enable) = 0;
    
    virtual ZRCSDKError GetLocalHDMIShareAudioPlaybackStatus(bool& isSupport, bool& isEnabled) = 0;
    
    virtual ZRCSDKError EnableLocalHDMIShareAudioPlayback(bool enable) = 0;
 
    virtual ZRCSDKError SetMeetingShareSetting(MeetingSharePrivilegeType type) = 0;
 
    virtual ZRCSDKError SetMeetingShareViewPrivilege(MeetingShareViewPrivilege type) = 0;
 
    virtual ZRCSDKError OptimizeVideoSharing(bool optimize) = 0;
 
    virtual ZRCSDKError AllowParticipantsShareDocs(bool allow) = 0;
 
    virtual ZRCSDKError ChangeDocsSharePrivilege(DocsSharePrivilegeType type) = 0;
 
    virtual ZRCSDKError ChangeDocsInitiatePrivilege(DocsInitiatePrivilegeType type) = 0;
 
    virtual ZRCSDKError GetDocsShareSettingsInfo(DocsShareSettingsInfo& info) = 0;
    
    virtual ZRCSDKError EnableAnnotationOverHDMI(bool enable) = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGSHAREHELPER_H