IWebinarBreakoutRoomHelper.h

Go to the documentation of this file.

 
#ifndef IWebinarBreakoutRoomHelper_h
#define IWebinarBreakoutRoomHelper_h
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
 
struct WebinarBOOptions
{
    bool     isPanelistCanChooseRoom = false;                    
    bool     isAttendeeCanChooseRoom = false;                    
    bool     isParticipantCanReturnToMainSessionAtAnyTime = true;
    bool     isAutoMoveAllAssignedParticipantsEnabled = false;   
    int      maxParticipantsCountPerRoom = 500;                  
 
    bool     isBOTimerEnabled = false;                              
    uint64_t boTimerDuration = 0;                                   
 
    bool     isNotifyMeWhenTimeIsUp = false;                        
 
    BO_STOP_COUNTDOWN countdownSeconds = BO_STOP_NOT_COUNTDOWN;     
};
 
struct BreakoutRoomUsersInfo
{
    std::string sessionBID;                 
    int32_t     userCount = 0;              
    std::vector<int32_t> userJoinIndexes;   
};
 
class IWebinarBOCreatorHelperSink
{
public:
    virtual ~IWebinarBOCreatorHelperSink() {}
 
    virtual void OnBOOptionsNotification(const WebinarBOOptions& boOptions) = 0;
    
    virtual void OnBORoomInfoListChanged(const std::vector<BreakoutRoomInfo>& boRoomInfoList) = 0;
};
 
class IWebinarBOCreatorHelper
{
public:
    virtual void RegisterSink(IWebinarBOCreatorHelperSink* pSink) = 0;
 
    virtual ZRCSDKError GetBOOptions(WebinarBOOptions& boOptions) = 0;
};
 
 
class IWebinarBOAdminHelperSink
{
public:
    virtual ~IWebinarBOAdminHelperSink() {}
 
    virtual void OnBOEndTimerUpdate(uint64_t remainingSecond) = 0;
 
    virtual void OnBOTimeIsUpNotification() = 0;
};
 
class IWebinarBOAdminHelper
{
public:
    virtual void RegisterSink(IWebinarBOAdminHelperSink* pSink) = 0;
 
    virtual ZRCSDKError StopBreakoutRooms() = 0;
};
 
 
class IWebinarBOAssistantHelper
{
public:
    virtual ZRCSDKError JoinBreakoutRoom(const std::string& sessionBID) = 0;
        
    virtual ZRCSDKError ResponseHostInviteToMainSession(bool accept) = 0;
};
 
 
class IWebinarBOAttendeeHelper
{
public:
    virtual ZRCSDKError JoinBreakoutRoom() = 0;
 
    virtual ZRCSDKError LeaveBreakoutRoom() = 0;
 
    virtual ZRCSDKError IsCanReturnMainSession(bool& canReturn) = 0;
};
 
 
class IWebinarBODataHelperSink
{
public:
    virtual ~IWebinarBODataHelperSink() {}
    
    virtual void OnGetBreakoutRoomUserList(const BreakoutRoomUsersInfo& roomUsers) = 0;
};
 
class IWebinarBODataHelper
{
public:
    virtual void RegisterSink(IWebinarBODataHelperSink* pSink) = 0;
 
    virtual ZRCSDKError GetBOUserStatus(BO_USER_STATUS& boUserStatus) = 0;
    
    virtual ZRCSDKError GetBreakoutRoomList(std::vector<BreakoutRoomInfo>& boRoomList) = 0;
    
    virtual ZRCSDKError GetBreakoutRoomUserList(const std::string& sessionBID) = 0;
};
 
 
class IWebinarBreakoutRoomHelperSink
{
public:
    virtual ~IWebinarBreakoutRoomHelperSink() {}
 
    virtual void OnBOStatusChanged(BO_STATUS boStatus) = 0;
    
    virtual void OnBOSwitchRequestReceived(const std::string& fromUserName, const BreakoutRoomInfo& newBORoomInfo) = 0;
    
    virtual void OnHostInviteReturnToMainSession() = 0;
 
    virtual void OnBOStopCountDown(uint64_t remainingSeconds) = 0;
 
    virtual void OnStartJoinBONotification() = 0;
    
    virtual void OnUpdateMeetingInfoNotification(const MeetingInfo& meetingInfo) = 0;
};
 
class IWebinarBreakoutRoomHelper
    : public IWebinarBOCreatorHelper
    , public IWebinarBOAdminHelper
    , public IWebinarBOAssistantHelper
    , public IWebinarBOAttendeeHelper
    , public IWebinarBODataHelper
{
public:
    virtual ~IWebinarBreakoutRoomHelper() {}
 
    virtual ZRCSDKError RegisterSink(IWebinarBreakoutRoomHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IWebinarBreakoutRoomHelperSink* pSink) = 0;
 
    virtual IWebinarBOCreatorHelper*   GetBOCreatorHelper() = 0;
    
    virtual IWebinarBOAdminHelper*     GetBOAdminHelper() = 0;
    
    virtual IWebinarBOAssistantHelper* GetBOAssistantHelper() = 0;
    
    virtual IWebinarBOAttendeeHelper*  GetBOAttendeeHelper() = 0;
    
    virtual IWebinarBODataHelper*      GetBODataHelper() = 0;
 
    virtual ZRCSDKError IsBOEnabled(bool& enabled) = 0;
 
    virtual ZRCSDKError IsBOStarted(bool& started) = 0;
    
    virtual ZRCSDKError IsInMainSession(bool& isInMainSession) = 0;
    
    virtual ZRCSDKError GetBOStatus(BO_STATUS& boStatus) = 0;
};
 
NS_ZRCSDK_END
 
#endif /* IWebinarBreakoutRoomHelper_h */