IMeetingService.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGSERVICE_H
#define ZRC_IMEETINGSERVICE_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum ExitMeetingCmd
{
    ExitMeetingCmdLeave,    
    ExitMeetingCmdEnd,      
};
 
enum ExitMeetingReason
{
    ExitMeetingReasonDefault = 0,    
    ExitMeetingReasonJoinBO,         
    ExitMeetingReasonLeaveBO,        
    ExitMeetingReasonRejoinNewMeeting 
};
 
enum WaitingHostReason
{
    WaitingHostStartMeeting = 0,    
    WaitingHostEndAnotherMeeting    
};
 
struct MeetingErrorInfo
{
    int32_t     errorCode = 0;      
    std::string errorInfo;          
    std::string errorTitle;         
    std::string errorDescLink;      
};
 
struct MeetingInvitationInfo
{
    std::string  callerContactID;   
    std::string  callerName;        
    std::string  callerAvatarUrl;   
    std::string  calleeContactID;   
    std::string  meetingID;         
    std::string  password;          
    int64_t meetingOptions = 0;     
    int64_t meetingNumber = 0;      
    int64_t expireTime = 0;         
};
 
struct BandwidthLimitInfo
{
    bool     isEnabled = false;             
    bool     isDisableSendVideo = false;    
    bool     isDisableRecvVideo = false;    
    uint32_t videoUpstreamLimit = 0;        
    uint32_t videoDownstreamLimit = 0;      
};
 
struct DataCenterRegion
{
    std::string dataCenterRegionMessage;    
    std::string learnMoreUrl;               
};
 
struct E2ESecurityCode
{
    std::string code;                       
    int64_t     secondsSinceLastUpdate = -1;
};
 
struct JBHWaitingHostInfo
{
    bool              showWaitForHostDialog = false;            
    WaitingHostReason reason = WaitingHostStartMeeting;         
    bool              enableStartMeetingWithHostKey = false;    
    MeetingItem       meeting;                                  
};
 
struct ConfDeviceLockStatus
{
    bool    isLocked = false;          
    int32_t remainTimeSec = 0;         
    int32_t wrongPwdInputCount = 0;    
};
 
struct E2eeMeetingStatus
{
    bool isPQCProtected = false; 
};
 
struct MeshInfoNotification
{
    int32_t unsignedParticipantCount = 0; 
    std::string meshMeetingPrivacyUrl;    
};
 
class IMeetingServiceSink
{
public:
    virtual ~IMeetingServiceSink() {}
 
    virtual void OnStartMeetingResult(int32_t result) = 0;
 
    virtual void OnStartPmiResult(int32_t result, const std::string& meetingNumber, MeetingType meetingType) = 0;
 
    virtual void OnStartPmiNotification(bool success) = 0;
 
    virtual void OnUpdateMeetingStatus(MeetingStatus meetingStatus) = 0;
 
    virtual void OnConfReadyNotification() = 0;
 
    virtual void OnUpdateMeetingInfoNotification(const MeetingInfo& meetingInfo) = 0;
 
    virtual void OnExitMeetingNotification(int32_t result, ExitMeetingReason reason) = 0;
 
    virtual void OnMeetingErrorNotification(const MeetingErrorInfo& errorInfo) = 0;
 
    virtual void OnMeetingEndedNotification(const MeetingErrorInfo& errorInfo) = 0;
 
    virtual void OnReceiveMeetingInviteNotification(const MeetingInvitationInfo& invitation) = 0;
 
    virtual void OnAnswerMeetingInviteResponse(int32_t result, const MeetingInvitationInfo& invitation, bool accepted) = 0;
 
    virtual void OnTreatedMeetingInviteNotification(const MeetingInvitationInfo& invitation, bool accepted) = 0;
 
    virtual void OnStartMeetingWithHostKeyResult(int32_t result) = 0;
 
    virtual void OnUpdateDataCenterRegionNotification(const DataCenterRegion& dcRegion) = 0;
 
    virtual void OnUpdateE2ESecurityCode(const E2ESecurityCode& code) = 0;
 
    virtual void OnBandwidthLimitNotification(const BandwidthLimitInfo& info) = 0;
 
    virtual void OnSendMeetingInviteEmailNotification(int32_t result) = 0;
 
    virtual void OnSetRoomTempDisplayNameNotification(bool isShow) = 0;
 
    virtual void OnMeetingNeedsPasswordNotification(bool showPasswordDialog, bool wrongAndRetry, const ConfDeviceLockStatus& lockStatus) = 0;
 
    virtual void OnConfDeviceLockStatusNotification(const ConfDeviceLockStatus& status) = 0;
 
    virtual void OnJBHWaitingHostNotification(bool showWaitForHostDialog, WaitingHostReason reason) = 0;
 
    virtual void OnE2eeMeetingStatusNotification(const E2eeMeetingStatus& e2eeMeetingStatus) = 0;
 
    virtual void OnMeshInfoNotification(const MeshInfoNotification& meshInfo) = 0;
 
    virtual void OnMeetingWillStopAutomatically() = 0;
 
    virtual void OnExtendMeetingResult(int32_t extendMins) = 0;
 
    virtual void OnConfirmPersonalLink(const std::string& personalLink) = 0;
};
 
class IMeetingListHelper;
class IThirdPartyMeetingHelper;
class IWaitingRoomHelper;
class IMeetingReminderHelper;
class IMeetingAudioHelper;
class IMeetingVideoHelper;
class IMeetingShareHelper;
class IMeetingViewLayoutHelper;
class ICameraControlHelper;
class IClosedCaptionHelper;
class IMeetingControlHelper;
class IParticipantHelper;
class IRecordingHelper;
class IBreakoutRoomHelper;
class IMeetingPollingHelper;
class IMeetingReactionEmojiHelper;
class IMeetingChatHelper;
class INDIHelper;
class IMeetingWebinarHelper;
class IVirtualBackgroundHelper;
class IMeetingQAHelper;
class ICloudWhiteboardHelper;
class ISmartTagHelper;
class IWebinarBreakoutRoomHelper;
 
class IMeetingService
{
public:
    virtual ~IMeetingService() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingServiceSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingServiceSink* pSink) = 0;
 
    virtual ZRCSDKError StartInstantMeeting() = 0;
 
    virtual ZRCSDKError MeetWithIMUsers(const std::vector<std::string>& contactIDs) = 0;
 
    virtual ZRCSDKError StartMeeting(const MeetingItem& meeting, bool bringShareToMeeting = false) = 0;
 
    virtual ZRCSDKError StartMeetingWithHostKey(const std::string& hostKey) = 0;
 
    virtual ZRCSDKError JoinMeetingWithMeetingNumber(const std::string& meetingNumber, bool bringShareToMeeting = false) = 0;
 
    virtual ZRCSDKError JoinMeetingWithURL(const std::string& url) = 0;
 
    virtual ZRCSDKError JoinMeetingWithContactID(const std::string& contactID) = 0;
 
    virtual ZRCSDKError JoinMeetingWithPersonalLinkName(const std::string& personalLinkName, bool bringShareToMeeting = false) = 0;
 
    virtual ZRCSDKError JoinMeetingWithPersonalLink(const std::string& personalLink) = 0;
 
    virtual ZRCSDKError ExitMeeting(ExitMeetingCmd exitCmd) = 0;
 
    virtual ZRCSDKError SetRoomTempDisplayNameForMeeting(const std::string& roomTempName) = 0;
 
    virtual ZRCSDKError SendMeetingPassword(const std::string& password) = 0;
 
    virtual ZRCSDKError CancelEnteringMeetingPassword() = 0;
 
    virtual ZRCSDKError CancelWaitingForHost() = 0;
 
    virtual ZRCSDKError AnswerMeetingInvite(const MeetingInvitationInfo& invite, bool accept) = 0;
 
    virtual ZRCSDKError InviteAttendees(const std::vector<std::string>& contactIDs) = 0;
 
    virtual ZRCSDKError InviteLegacyRoomSystems(const std::vector<LegacyRoomSystem>& roomSystems) = 0;
 
    virtual ZRCSDKError InviteLegacyRoomSystemWithIpOrE164Number(const std::string& ipOrE164Number, RoomSystemProtocolType protocolType, bool cancel) = 0;
 
    virtual ZRCSDKError SendMeetingInviteEmail(const std::string& recipients) = 0;
 
    virtual ZRCSDKError RequestE2ESecurityCode() = 0;
 
    virtual ZRCSDKError SendDTMF(const std::string& digitKey, int32_t userID) = 0;
 
    virtual ZRCSDKError GetMeetingStatus(MeetingStatus& status) = 0;
 
    virtual ZRCSDKError GetMeetingInfo(MeetingInfo& info) = 0;
    
    virtual ZRCSDKError ExtendMeeting() = 0;
 
    virtual ZRCSDKError CancelConfirmPersonalLink() = 0;
    
    virtual IMeetingListHelper* GetMeetingListHelper() = 0;
 
    virtual IThirdPartyMeetingHelper* GetThirdPartyMeetingHelper() = 0;
 
    virtual IMeetingReminderHelper* GetMeetingReminderHelper() = 0;
 
    virtual IWaitingRoomHelper* GetWaitingRoomHelper() = 0;
 
    virtual IMeetingAudioHelper* GetMeetingAudioHelper() = 0;
 
    virtual IMeetingVideoHelper* GetMeetingVideoHelper() = 0;
 
    virtual IMeetingShareHelper* GetMeetingShareHelper() = 0;
 
    virtual IRecordingHelper* GetRecordingHelper() = 0;
 
    virtual IMeetingViewLayoutHelper* GetMeetingViewLayoutHelper() = 0;
 
    virtual ICameraControlHelper* GetCameraControlHelper() = 0;
 
    virtual IClosedCaptionHelper* GetClosedCaptionHelper() = 0;
 
    virtual IMeetingControlHelper* GetMeetingControlHelper() = 0;
 
    virtual IParticipantHelper* GetParticipantHelper() = 0;
 
    virtual IBreakoutRoomHelper* GetBreakoutRoomHelper() = 0;
 
    virtual IMeetingReactionEmojiHelper* GetMeetingReactionEmojiHelper() = 0;
 
    virtual IMeetingChatHelper* GetMeetingChatHelper() = 0;
 
    virtual INDIHelper* GetNDIHelper() = 0;
 
    virtual IMeetingWebinarHelper* GetMeetingWebinarHelper() = 0;
 
    virtual IVirtualBackgroundHelper* GetVirtualBackgroundHelper() = 0;
 
    virtual IMeetingPollingHelper* GetMeetingPollingHelper() = 0;
 
    virtual IMeetingQAHelper* GetMeetingQAHelper() = 0;
 
    virtual IWebinarBreakoutRoomHelper*  GetWebinarBreakoutRoomHelper() = 0;
 
    virtual ICloudWhiteboardHelper* GetCloudWhiteboardHelper() = 0;
    
    virtual ISmartTagHelper* GetSmartTagHelper() = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGSERVICE_H