Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
IMeetingBOController Class Referenceabstract

Meeting breakout rooms controller interface. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions

virtual bool SetEvent (IMeetingBOControllerEvent *event)=0
 Sets breakout room callback event handler.
 
virtual IBOCreatorGetBOCreatorHelper ()=0
 Gets the pointer of BO creator object.
 
virtual IBOAdminGetBOAdminHelper ()=0
 Gets the pointer of BO administrator object.
 
virtual IBOAssistantGetBOAssistantHelper ()=0
 Gets the pointer of BO assistant object.
 
virtual IBOAttendeeGetBOAttedeeHelper ()=0
 Gets the pointer of BO attendee object.
 
virtual IBODataGetBODataHelper ()=0
 Gets the pointer of BO data object.
 
virtual bool IsBOStarted ()=0
 Determines if the BO is started or not.
 
virtual bool IsBOEnabled ()=0
 Determines if the BO feature is enabled in current meeting.
 
virtual bool IsInBOMeeting ()=0
 Determines if myself is in BO meeting.
 
virtual BO_STATUS GetBOStatus ()=0
 Gets current BO status.
 
virtual bool IsBroadcastingVoiceToBO ()=0
 Query if the host is broadcasting voice to BO.
 
virtual const zchar_tGetJoiningBOName ()=0
 Gets the name of the BO you are going to. When you enter a BO or are switched to another BO by the host, maybe you need the BO name to display on transfer UI.
 

Detailed Description

Meeting breakout rooms controller interface.

Definition at line 863 of file meeting_breakout_rooms_interface_v2.h.

Member Function Documentation

◆ GetBOAdminHelper()

virtual IBOAdmin * IMeetingBOController::GetBOAdminHelper ( )
pure virtual

Gets the pointer of BO administrator object.

Returns
If the function succeeds, the return value is a pointer to IBOAdmin object. Otherwise, the return value is nullptr.

◆ GetBOAssistantHelper()

virtual IBOAssistant * IMeetingBOController::GetBOAssistantHelper ( )
pure virtual

Gets the pointer of BO assistant object.

Returns
If the function succeeds, the return value is a pointer to IBOAssistant object. Otherwise, the return value is nullptr.

◆ GetBOAttedeeHelper()

virtual IBOAttendee * IMeetingBOController::GetBOAttedeeHelper ( )
pure virtual

Gets the pointer of BO attendee object.

Returns
If the function succeeds, the return value is a pointer to IBOAttendee object. Otherwise, the return value is nullptr.

◆ GetBOCreatorHelper()

virtual IBOCreator * IMeetingBOController::GetBOCreatorHelper ( )
pure virtual

Gets the pointer of BO creator object.

Returns
If the function succeeds, the return value is a pointer to IBOCreator object. Otherwise, the return value is nullptr.

◆ GetBODataHelper()

virtual IBOData * IMeetingBOController::GetBODataHelper ( )
pure virtual

Gets the pointer of BO data object.

Returns
If the function succeeds, the return value is a pointer to IBOData object. Otherwise, the return value is nullptr.

◆ GetBOStatus()

virtual BO_STATUS IMeetingBOController::GetBOStatus ( )
pure virtual

Gets current BO status.

Returns
The return value is a enum for bo status.

◆ GetJoiningBOName()

virtual const zchar_t * IMeetingBOController::GetJoiningBOName ( )
pure virtual

Gets the name of the BO you are going to. When you enter a BO or are switched to another BO by the host, maybe you need the BO name to display on transfer UI.

◆ IsBOEnabled()

virtual bool IMeetingBOController::IsBOEnabled ( )
pure virtual

Determines if the BO feature is enabled in current meeting.

Returns
true indicates that BO feature is enabled in current meeting.

◆ IsBOStarted()

virtual bool IMeetingBOController::IsBOStarted ( )
pure virtual

Determines if the BO is started or not.

Returns
true if the host has started the BO. Otherwise, false.

◆ IsBroadcastingVoiceToBO()

virtual bool IMeetingBOController::IsBroadcastingVoiceToBO ( )
pure virtual

Query if the host is broadcasting voice to BO.

Returns
true if the host is broadcasting voice to BO. Otherwise, false.

◆ IsInBOMeeting()

virtual bool IMeetingBOController::IsInBOMeeting ( )
pure virtual

Determines if myself is in BO meeting.

Returns
true indicates that i am in a BO meeting.

◆ SetEvent()

virtual bool IMeetingBOController::SetEvent ( IMeetingBOControllerEvent * event)
pure virtual

Sets breakout room callback event handler.

Parameters
event,Apointer to the IMeetingBOControllerEvent.
Returns
true if the function succeeds. Otherwise, false.