meeting_breakout_rooms_interface_v2.h

Go to the documentation of this file.

 
#ifndef _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
#define _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
#include "zoom_sdk_def.h"
 
#if defined(WIN32)
#include "customized_ui/customized_share_render.h"
#endif
 
BEGIN_ZOOM_SDK_NAMESPACE

typedef enum
{
    BO_CTRL_USER_STATUS_UNASSIGNED          = 1, 
    BO_CTRL_USER_STATUS_ASSIGNED_NOT_JOIN   = 2, 
    BO_CTRL_USER_STATUS_IN_BO               = 3, 
    BO_CTRL_USER_STATUS_UNKNOWN             = 4, 
}BO_CTRL_USER_STATUS;
 
typedef enum
{
    ATTENDEE_REQUEST_FOR_HELP_RESULT_IDLE,   
    ATTENDEE_REQUEST_FOR_HELP_RESULT_BUSY,
    ATTENDEE_REQUEST_FOR_HELP_RESULT_IGNORE,
    ATTENDEE_REQUEST_FOR_HELP_RESULT_HOST_ALREADY_IN_BO 
}ATTENDEE_REQUEST_FOR_HELP_RESULT;

class IBOMeeting
{
public:
    virtual ~IBOMeeting() {}
    virtual const zchar_t* GetBOID() = 0;

    virtual const zchar_t* GetBOName() = 0;

    virtual IList<const zchar_t*>* GetBOUserList() = 0;

    virtual BO_CTRL_USER_STATUS GetBOUserStatus(const zchar_t* strUserID) = 0;
};


enum PreAssignBODataStatus
{
    PreAssignBODataStatus_none,  
    PreAssignBODataStatus_downloading, 
    PreAssignBODataStatus_download_ok, 
    PreAssignBODataStatus_download_fail      
};
 
struct BOOption;
class IBOCreatorEvent 
{
public:
    virtual ~IBOCreatorEvent() {}

    virtual void onBOCreateSuccess(const zchar_t* strBOID) = 0;

    virtual void OnWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status) = 0;

    virtual void OnBOOptionChanged(const BOOption& newOption) = 0;

    virtual void onCreateBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;

    virtual void onRemoveBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;

    virtual void onUpdateBONameResponse(bool bSuccess, const zchar_t* strBOID) = 0;
};

enum BO_STOP_COUNTDOWN
{
    BO_STOP_NOT_COUNTDOWN,
    BO_STOP_COUNTDOWN_SECONDS_10,
    BO_STOP_COUNTDOWN_SECONDS_15,
    BO_STOP_COUNTDOWN_SECONDS_30,
    BO_STOP_COUNTDOWN_SECONDS_60,
    BO_STOP_COUNTDOWN_SECONDS_120,
};

struct BOOption
{
    BO_STOP_COUNTDOWN countdown_seconds; 
    bool IsParticipantCanChooseBO;    
    bool IsParticipantCanReturnToMainSessionAtAnyTime; 
    bool IsAutoMoveAllAssignedParticipantsEnabled;   
    bool IsBOTimerEnabled;  
    bool IsTimerAutoStopBOEnabled; 
    unsigned int nTimerDurationMinutes;   

    bool IsAttendeeContained;
    bool IsPanelistCanChooseBO; 
    bool IsAttendeeCanChooseBO; 
    bool IsUserConfigMaxRoomUserLimitsEnabled;  
    unsigned int  nUserConfigMaxRoomUserLimits;

    bool isAICompanionEnabled;

    bool isTranscriptionEnabled;
 
    BOOption()
    {
        countdown_seconds = BO_STOP_COUNTDOWN_SECONDS_60;
        IsParticipantCanChooseBO = false;
        IsParticipantCanReturnToMainSessionAtAnyTime = true;
        IsAutoMoveAllAssignedParticipantsEnabled = false;
        IsBOTimerEnabled = false;
        IsTimerAutoStopBOEnabled = false;
        nTimerDurationMinutes = 0;
        IsPanelistCanChooseBO = false;
        IsAttendeeCanChooseBO = false;
        IsUserConfigMaxRoomUserLimitsEnabled = false;
        nUserConfigMaxRoomUserLimits = 20;
        IsAttendeeContained = false;
        isAICompanionEnabled = false;
        isTranscriptionEnabled = false;
    }
};

class IBatchCreateBOHelper
{
public:
    virtual SDKError CreateBOTransactionBegin() = 0;

    virtual bool AddNewBoToList(const zchar_t* strNewBOName) = 0;

    virtual SDKError CreateBoTransactionCommit() = 0;
};

class IBOCreator
{
public:
 
    virtual void SetEvent(IBOCreatorEvent* pEvent) = 0;

    virtual const zchar_t* CreateBO(const zchar_t* strBOName) = 0;
    
    virtual bool CreateBreakoutRoom(const zchar_t* strBOName) = 0;

    virtual bool UpdateBOName(const zchar_t* strBOID, const zchar_t* strNewBOName) = 0; 
    
    virtual bool RemoveBO(const zchar_t* strBOID) = 0;
    
    virtual bool AssignUserToBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
    
    virtual bool RemoveUserFromBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;                                    

    virtual SDKError SetBOOption(const BOOption& option) = 0;
    
    virtual bool GetBOOption(BOOption& option) = 0;

    virtual IBatchCreateBOHelper* GetBatchCreateBOHelper() = 0;

    virtual bool IsWebPreAssignBOEnabled() = 0;

    virtual SDKError RequestAndUseWebPreAssignBOList() = 0;

    virtual PreAssignBODataStatus GetWebPreAssignBODataStatus() = 0;

    virtual bool CreateWebinarBo(const zchar_t* strBOName) = 0;

    virtual bool IsAICompanionSupported() = 0;

    virtual bool IsTranscriptionSupported() = 0;
};

enum BOControllerError
{
    BOControllerError_NULL_POINTER = 0,
    BOControllerError_WRONG_CURRENT_STATUS,
    BOControllerError_TOKEN_NOT_READY,
    BOControllerError_NO_PRIVILEGE,
    BOControllerError_BO_LIST_IS_UPLOADING,
    BOControllerError_UPLOAD_FAIL,
    BOControllerError_NO_ONE_HAS_BEEN_ASSIGNED,
    BOControllerError_UNKNOWN = 100
};

class IBOAdminEvent
{
public:
 
    virtual ~IBOAdminEvent() {}

    virtual void onHelpRequestReceived(const zchar_t* strUserID) = 0;

    virtual void onStartBOError(BOControllerError errCode) = 0;

    virtual void onBOEndTimerUpdated(int remaining, bool isTimesUpNotice) = 0;

    virtual void onStartBOResponse(bool bSuccess) = 0;

    virtual void onStopBOResponse(bool bSuccess) = 0;
};

class IBOAdmin
{
public:
    virtual bool StartBO() = 0;

    virtual bool StopBO() = 0;
    
    virtual bool AssignNewUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
    
    virtual bool SwitchAssignedUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
    
    virtual bool CanStartBO() = 0;
    
    virtual void SetEvent(IBOAdminEvent* pEvent) = 0;
    
    virtual bool JoinBOByUserRequest(const zchar_t* strUserID) = 0;
    
    virtual bool IgnoreUserHelpRequest(const zchar_t* strUserID) = 0;

    virtual bool BroadcastMessage(const zchar_t* strMsg) = 0;

    virtual bool InviteBOUserReturnToMainSession(const zchar_t* strUserID) = 0;

    virtual bool IsBroadcastVoiceToBOSupport() = 0;

    virtual bool CanBroadcastVoiceToBO() = 0;

    virtual bool BroadcastVoiceToBo(bool bStart) = 0;
};


class IBOAssistant
{
public:
    virtual bool JoinBO(const zchar_t* strBOID) = 0;
    
    virtual bool LeaveBO() = 0; 
};


class IBOAttendeeEvent
{
public:
 
    virtual ~IBOAttendeeEvent() {}

    virtual void onHelpRequestHandleResultReceived(ATTENDEE_REQUEST_FOR_HELP_RESULT eResult) = 0;

    virtual void onHostJoinedThisBOMeeting() = 0;

    virtual void onHostLeaveThisBOMeeting() = 0;
};

class IBOAttendee
{
public:
    virtual bool JoinBo() = 0;

    virtual bool LeaveBo() = 0;

    virtual const zchar_t* GetBoName() = 0;

    virtual void SetEvent(IBOAttendeeEvent* pEvent) = 0;

    virtual bool RequestForHelp() = 0;

    virtual bool IsHostInThisBO() = 0;

    virtual bool IsCanReturnMainSession() = 0;
};


class IBODataEvent
{
public:
    virtual ~IBODataEvent() {}

    virtual void onBOInfoUpdated(const zchar_t* strBOID) = 0; 
    
    virtual void onUnAssignedUserUpdated() = 0; 

    virtual void OnBOListInfoUpdated() = 0;
};

class IBOData
{
public:
    virtual void SetEvent(IBODataEvent* pEvent) = 0;

    virtual IList<const zchar_t*>* GetUnassignedUserList() = 0;

    virtual IList<const zchar_t*>* GetBOMeetingIDList() = 0;
    
    virtual const zchar_t* GetBOUserName(const zchar_t* strUserID) = 0;

    virtual bool IsBOUserMyself(const zchar_t* strUserID) = 0;

    virtual IBOMeeting* GetBOMeetingByID(const zchar_t* strBOID) = 0;

    virtual const zchar_t* GetCurrentBoName() = 0;
};


enum BO_STATUS
{
    BO_STATUS_INVALID = 0, 
    BO_STATUS_EDIT = 1,  
    BO_STATUS_STARTED = 2,
    BO_STATUS_STOPPING = 3, 
    BO_STATUS_ENDED = 4     
};

class IReturnToMainSessionHandler
{
public:
    virtual ~IReturnToMainSessionHandler() {}

    virtual bool ReturnToMainSession() = 0;

    virtual void Ignore() = 0;
};

class IMeetingBOControllerEvent
{
public:
    virtual ~IMeetingBOControllerEvent() {}

    virtual void onHasCreatorRightsNotification(IBOCreator* pCreatorObj) = 0;

    virtual void onHasAdminRightsNotification(IBOAdmin* pAdminObj) = 0;

    virtual void onHasAssistantRightsNotification(IBOAssistant* pAssistantObj) = 0;

    virtual void onHasAttendeeRightsNotification(IBOAttendee* pAttendeeObj) = 0;

    virtual void onHasDataHelperRightsNotification(IBOData* pDataHelperObj) = 0;
 
    virtual void onLostCreatorRightsNotification() = 0;
    
    virtual void onLostAdminRightsNotification() = 0;
 
    virtual void onLostAssistantRightsNotification() = 0;

    virtual void onLostAttendeeRightsNotification() = 0;
 
    virtual void onLostDataHelperRightsNotification() = 0;

    virtual void onNewBroadcastMessageReceived(const zchar_t* strMsg, unsigned int nSenderID, const zchar_t* strSenderName) = 0;

    virtual void onBOStopCountDown(unsigned int nSeconds) = 0;

    virtual void onHostInviteReturnToMainSession(const zchar_t* strName, IReturnToMainSessionHandler* handler) = 0;

    virtual void onBOStatusChanged(BO_STATUS eStatus) = 0; 

    virtual void onBOSwitchRequestReceived(const zchar_t* strNewBOName, const zchar_t* strNewBOID) = 0;

    virtual void onBroadcastBOVoiceStatus(bool bStart) = 0;
#if defined(WIN32)
    virtual void onShareFromMainSession(const unsigned int iSharingID, SharingStatus status, IShareAction* pShareAction) = 0;
#endif
};

class IMeetingBOController
{
public:
    virtual bool SetEvent(IMeetingBOControllerEvent* event) = 0;

    virtual IBOCreator*    GetBOCreatorHelper() = 0;

    virtual IBOAdmin*      GetBOAdminHelper() = 0;

    virtual IBOAssistant*  GetBOAssistantHelper() = 0;

    virtual IBOAttendee*   GetBOAttedeeHelper() = 0;

    virtual IBOData*       GetBODataHelper() = 0;

    virtual bool IsBOStarted() = 0;
    
    virtual bool IsBOEnabled() = 0;

    virtual bool IsInBOMeeting() = 0;

    virtual BO_STATUS GetBOStatus() = 0;

    virtual bool IsBroadcastingVoiceToBO() = 0;

    virtual const zchar_t* GetJoiningBOName() = 0;
};
 
END_ZOOM_SDK_NAMESPACE
#endif