Windows SDK API Reference
Loading...
Searching...
No Matches
IMeetingBOControllerEvent Class Referenceabstract

BO controller callback event handler. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions

virtual ~IMeetingBOControllerEvent ()
 
virtual void onHasCreatorRightsNotification (IBOCreator *pCreatorObj)=0
 To notify that you has creator right.
 
virtual void onHasAdminRightsNotification (IBOAdmin *pAdminObj)=0
 To notify that you has admin right.
 
virtual void onHasAssistantRightsNotification (IBOAssistant *pAssistantObj)=0
 To notify that you has assistant right.
 
virtual void onHasAttendeeRightsNotification (IBOAttendee *pAttendeeObj)=0
 To notify that you has attendee right.
 
virtual void onHasDataHelperRightsNotification (IBOData *pDataHelperObj)=0
 To notify that you has data right.
 
virtual void onLostCreatorRightsNotification ()=0
 To notify that you lost creator right.
 
virtual void onLostAdminRightsNotification ()=0
 To notify that you lost admin right.
 
virtual void onLostAssistantRightsNotification ()=0
 To notify that you lost assistant right.
 
virtual void onLostAttendeeRightsNotification ()=0
 To notify that you lost attendee right.
 
virtual void onLostDataHelperRightsNotification ()=0
 To notify that you lost data right.
 
virtual void onNewBroadcastMessageReceived (const zchar_t *strMsg, unsigned int nSenderID, const zchar_t *strSenderName)=0
 To notify that you receive a broadcast message.
 
virtual void onBOStopCountDown (unsigned int nSeconds)=0
 When BOOption.countdown_seconds != BO_STOP_NOT_COUNTDOWN, host stop BO and all users receive the event.
 
virtual void onHostInviteReturnToMainSession (const zchar_t *strName, IReturnToMainSessionHandler *handler)=0
 When you are in BO, host invite you return to main session, you will receive the event.
 
virtual void onBOStatusChanged (BO_STATUS eStatus)=0
 When host change the BO status, all users receive the event.
 
virtual void onBOSwitchRequestReceived (const zchar_t *strNewBOName, const zchar_t *strNewBOID)=0
 Whenever the host switches you to another BO while you are assigned but haven't joined the BO, you will receive this event.
 
virtual void onBroadcastBOVoiceStatus (bool bStart)=0
 The status of broadcasting voice to BO has been changed.
 

Detailed Description

BO controller callback event handler.

Definition at line 519 of file meeting_breakout_rooms_interface_v2.h.

Constructor & Destructor Documentation

◆ ~IMeetingBOControllerEvent()

virtual IMeetingBOControllerEvent::~IMeetingBOControllerEvent ( )
inlinevirtual

Definition at line 522 of file meeting_breakout_rooms_interface_v2.h.

522{}

Member Function Documentation

◆ onBOStatusChanged()

virtual void IMeetingBOControllerEvent::onBOStatusChanged ( BO_STATUS eStatus)
pure virtual

When host change the BO status, all users receive the event.

Parameters
eStatus,currentstatus of BO.

◆ onBOStopCountDown()

virtual void IMeetingBOControllerEvent::onBOStopCountDown ( unsigned int nSeconds)
pure virtual

When BOOption.countdown_seconds != BO_STOP_NOT_COUNTDOWN, host stop BO and all users receive the event.

Parameters
nSeconds,thecountdown seconds.

◆ onBOSwitchRequestReceived()

virtual void IMeetingBOControllerEvent::onBOSwitchRequestReceived ( const zchar_t * strNewBOName,
const zchar_t * strNewBOID )
pure virtual

Whenever the host switches you to another BO while you are assigned but haven't joined the BO, you will receive this event.

Parameters
strNewBONameThe new BO name.
strNewBOIDThe new BO ID. If the current user is IBOAttendee, then the 2nd parameter strNewBOID will return NULL.

◆ onBroadcastBOVoiceStatus()

virtual void IMeetingBOControllerEvent::onBroadcastBOVoiceStatus ( bool bStart)
pure virtual

The status of broadcasting voice to BO has been changed.

Parameters
bStarttrue for start and false for stop.

◆ onHasAdminRightsNotification()

virtual void IMeetingBOControllerEvent::onHasAdminRightsNotification ( IBOAdmin * pAdminObj)
pure virtual

To notify that you has admin right.

Parameters
pAdminObj,thepointer of admin object. For more details, see IBOAdmin enum.

◆ onHasAssistantRightsNotification()

virtual void IMeetingBOControllerEvent::onHasAssistantRightsNotification ( IBOAssistant * pAssistantObj)
pure virtual

To notify that you has assistant right.

Parameters
pAssistantObj,thepointer of assistant object. For more details, see IBOAssistant enum.

◆ onHasAttendeeRightsNotification()

virtual void IMeetingBOControllerEvent::onHasAttendeeRightsNotification ( IBOAttendee * pAttendeeObj)
pure virtual

To notify that you has attendee right.

Parameters
pAttendeeObj,thepointer of attendee object. For more details, see IBOAttendee enum.

◆ onHasCreatorRightsNotification()

virtual void IMeetingBOControllerEvent::onHasCreatorRightsNotification ( IBOCreator * pCreatorObj)
pure virtual

To notify that you has creator right.

Parameters
pCreatorObj,thepointer of creator object. For more details, see IBOCreator enum.

◆ onHasDataHelperRightsNotification()

virtual void IMeetingBOControllerEvent::onHasDataHelperRightsNotification ( IBOData * pDataHelperObj)
pure virtual

To notify that you has data right.

Parameters
pDataHelperObj,thepointer of data helper object. For more details, see IBOData enum.

◆ onHostInviteReturnToMainSession()

virtual void IMeetingBOControllerEvent::onHostInviteReturnToMainSession ( const zchar_t * strName,
IReturnToMainSessionHandler * handler )
pure virtual

When you are in BO, host invite you return to main session, you will receive the event.

Parameters
strName,thehost name.

◆ onLostAdminRightsNotification()

virtual void IMeetingBOControllerEvent::onLostAdminRightsNotification ( )
pure virtual

To notify that you lost admin right.

◆ onLostAssistantRightsNotification()

virtual void IMeetingBOControllerEvent::onLostAssistantRightsNotification ( )
pure virtual

To notify that you lost assistant right.

◆ onLostAttendeeRightsNotification()

virtual void IMeetingBOControllerEvent::onLostAttendeeRightsNotification ( )
pure virtual

To notify that you lost attendee right.

◆ onLostCreatorRightsNotification()

virtual void IMeetingBOControllerEvent::onLostCreatorRightsNotification ( )
pure virtual

To notify that you lost creator right.

◆ onLostDataHelperRightsNotification()

virtual void IMeetingBOControllerEvent::onLostDataHelperRightsNotification ( )
pure virtual

To notify that you lost data right.

◆ onNewBroadcastMessageReceived()

virtual void IMeetingBOControllerEvent::onNewBroadcastMessageReceived ( const zchar_t * strMsg,
unsigned int nSenderID,
const zchar_t * strSenderName )
pure virtual

To notify that you receive a broadcast message.

Parameters
strMsg,themessage content.
nSenderID,theSenderID.