IThirdPartyMeetingHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_ITHIRDPARTYMEETINGHELPER_H
#define ZRC_ITHIRDPARTYMEETINGHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum RoomSystemCallingStatus
{
    RoomSystemCallingStatusAccepted = 0,                      
    RoomSystemCallingStatusRinging = 1,                       
    RoomSystemCallingStatusTimeOut = 2,                       
    RoomSystemCallingStatusFailed = 3,                        
    RoomSystemCallingStatusFailedNotSupportEncryption = 4,    
    RoomSystemCallingStatusExceedFreePorts = 5,               
};
 
enum IntegrationMeetingState
{
    IntegrationMeetingStateNone = 0,        
    IntegrationMeetingStateRejoining,       
    IntegrationMeetingStateJoining,         
    IntegrationMeetingStateWaitingRoom,     
    IntegrationMeetingStateConnected,       
    IntegrationMeetingStateDisconnecting,   
    IntegrationMeetingStateDisconnected,    
    IntegrationMeetingStateNeedPassword,    
};
 
enum IntegrationContentShareState
{
    IntegrationContentShareStateInactive = 0,    
    IntegrationContentShareStateActive,          
};
 
enum IntegrationMeetingLayoutType
{
    INTEGRATION_MEETING_FULL_SCREEN = 1 << 0,
    INTEGRATION_MEETING_SIDEBAR_LEFT = 1 << 1,
    INTEGRATION_MEETING_SIDEBAR_RIGHT = 1 << 2,
    INTEGRATION_MEETING_GRID = 1 << 3,
    INTEGRATION_MEETING_TOP_BAR = 1 << 4,
    INTEGRATION_MEETING_BOTTOM_BAR = 1 << 5
};
 
enum IntegrationMeetingJoinMethod
{
    IntegrationMeetingJoinMethodWebClient = 0,  
    IntegrationMeetingJoinMethodSIP,            
};
 
struct IntegrationMeetingInfo
{
    ThirdPartyMeetingServiceProvider provider = ThirdPartyMeetingServiceProviderInvalid;  
    IntegrationMeetingState meetingState = IntegrationMeetingStateNone;                   
    std::string meetingTitle;                                                             
    std::string meetingID;                                                                
    bool isAudioMuted = false;                                                            
    bool isVideoMuted = false;                                                            
    MeetingItem meetingListItem;                                                          
    bool isSupportCameraControl = false;                                                  
};
 
struct InterOperabilityInfo
{
    ThirdPartyMeetingServiceProvider meetingType = ThirdPartyMeetingServiceProviderInvalid; 
    bool supportJoinMeeting = false;                                                        
    bool supportJoinWebClient = false;                                                      
    bool supportSipJoin = false;                                                            
    bool supportPhoneJoin = false;                                                          
    std::vector<IntegrationMeetingJoinMethod> preferredJoinMethod;                          
    bool isPexipEnabled = false;                                                            
};
 
struct IntegrationMeetingErrorInfo
{
    int32_t errorCode = 0;      
    std::string errorMessage;   
};
 
struct IntegrationMeetingProblemReportInfo
{
    std::string correlationID;  
};
 
struct IntegrationMeetingContentShareInfo
{
    bool isHDMIContentShareAvailable = false;                                                   
    IntegrationContentShareState contentShareState = IntegrationContentShareStateInactive;      
};
 
struct IntegrationMeetingLayoutInfo
{
    uint32_t availableLayoutType = 0;   
    uint32_t selectedLayoutType = 0;    
};
 
class IThirdPartyMeetingHelperSink
{
public:
    virtual ~IThirdPartyMeetingHelperSink() {}
 
    virtual void OnAskToJoinThirdPartyMeeting(const MeetingItem& item) = 0;
 
    virtual void OnPSTNCallOutNotification(PSTNCallOutStatus callStatus) = 0;
 
    virtual void OnPSTNCalloutResult(bool isCancel, bool isSwitchToNormalMeeting, const std::string& phoneNumber, const std::string& userName) = 0;
 
    virtual void OnRoomSystemJoinedNotification(int32_t userID, const std::string& userName) = 0;
 
    virtual void OnRoomSystemCallingStatusNotification(RoomSystemCallingStatus status) = 0;
 
    virtual void OnStartIntegrationMeetingResult(int32_t result, int32_t serviceProvider) = 0;
 
    virtual void OnUpdateIntegrationMeetingInfo(const IntegrationMeetingInfo& info) = 0;
 
    virtual void OnUpdateIntegrationMeetingErrorInfo(const IntegrationMeetingErrorInfo& info) = 0;
 
    virtual void OnUpdateIntegrationMeetingContentShareInfo(const IntegrationMeetingContentShareInfo& info) = 0;
 
    virtual void OnUpdateIntegrationMeetingLayoutInfo(const IntegrationMeetingLayoutInfo& info) = 0;
 
    virtual void OnUpdateSupportIntegrationTeamsMeeting(bool isSupport) = 0;
 
    virtual void OnUpdateSupportIntegrationTeamsMeetingForAdhoc(bool isSupport) = 0;
 
    virtual void OnUpdateSupportIntegrationGoogleMeet(bool isSupport) = 0;
};
 
class IThirdPartyMeetingHelper
{
public:
    virtual ~IThirdPartyMeetingHelper() {}
 
    virtual ZRCSDKError RegisterSink(IThirdPartyMeetingHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IThirdPartyMeetingHelperSink* pSink) = 0;
 
    virtual ZRCSDKError CallOutPSTNUser(const std::string& phoneNumber, bool cancelCall, bool hasVoicePrompt) = 0;
 
    virtual ZRCSDKError StartThirdPartyMeetingByPSTNCall(const MeetingItem& meeting) = 0;
 
    virtual ZRCSDKError SwitchPstnCallToMeeting() = 0;
 
    virtual ZRCSDKError StartThirdPartyMeetingByRoomSystemCall(const MeetingItem& meeting) = 0;
 
    virtual ZRCSDKError StartIntegrationMeeting(const MeetingItem& meeting) = 0;
 
    virtual ZRCSDKError JoinIntegrationMeeting(const std::string& meetingID, const std::string& password, ThirdPartyMeetingServiceProvider provider) = 0;
 
    virtual ZRCSDKError RejoinIntegrationMeeting() = 0;
 
    virtual ZRCSDKError LeaveIntegrationMeeting() = 0;
 
    virtual ZRCSDKError MuteIntegrationAudio(bool mute) = 0;
 
    virtual ZRCSDKError StopIntegrationVideo(bool stop) = 0;
 
    virtual ZRCSDKError StopIntegrationContentShare(bool stop) = 0;
    
    virtual ZRCSDKError ChangeIntegrationLayout(uint32_t selectedLayoutType) = 0;
 
    virtual ZRCSDKError GetInterOperabilityInfoByMeetingType(ThirdPartyMeetingServiceProvider meetingType, InterOperabilityInfo& info) = 0;
};
 
NS_ZRCSDK_END
 
 
#endif    //ZRC_ITHIRDPARTYMEETINGHELPER_H