IMeetingBOController Class Reference

Meeting breakout rooms controller interface. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions
virtual bool	SetEvent (IMeetingBOControllerEvent *event)=0
	Set breakout room callback event handler.
virtual IBOCreator *	GetBOCreatorHelper ()=0
	Get the pointer of BO creator object.
virtual IBOAdmin *	GetBOAdminHelper ()=0
	Get the pointer of BO administrator object.
virtual IBOAssistant *	GetBOAssistantHelper ()=0
	Get the pointer of BO assistant object.
virtual IBOAttendee *	GetBOAttedeeHelper ()=0
	Get the pointer of BO attendee object.
virtual IBOData *	GetBODataHelper ()=0
	Get the pointer of BO data object.
virtual bool	IsBOStarted ()=0
	Determine if the BO is started or not.
virtual bool	IsBOEnabled ()=0
	Determine if the BO feature is enabled in current meeting.
virtual bool	IsInBOMeeting ()=0
	Determine if myself is in BO meeting.
virtual BO_STATUS	GetBOStatus ()=0
	Get current BO status.
virtual bool	IsBroadcastingVoiceToBO ()=0
	Query if the host is broadcasting voice to BO.
virtual const zchar_t *	GetJoiningBOName ()=0
	Get 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 634 of file meeting_breakout_rooms_interface_v2.h.

Member Function Documentation

GetBOAdminHelper()

virtual IBOAdmin * IMeetingBOController::GetBOAdminHelper ( )

pure virtual

Get the pointer of BO administrator object.

Returns

If the function succeeds, the return value is a pointer to IBOAdmin object. For more details, see IBOAdmin, Otherwise failed, the return value is nullptr.

GetBOAssistantHelper()

virtual IBOAssistant * IMeetingBOController::GetBOAssistantHelper ( )

pure virtual

Get the pointer of BO assistant object.

Returns

If the function succeeds, the return value is a pointer to IBOAssistant object. For more details, see IBOAssistant, Otherwise failed, the return value is nullptr.

GetBOAttedeeHelper()

virtual IBOAttendee * IMeetingBOController::GetBOAttedeeHelper ( )

pure virtual

Get the pointer of BO attendee object.

Returns

If the function succeeds, the return value is a pointer to IBOAttendee object. For more details, see IBOAttendee, Otherwise failed, the return value is nullptr.

GetBOCreatorHelper()

virtual IBOCreator * IMeetingBOController::GetBOCreatorHelper ( )

pure virtual

Get the pointer of BO creator object.

Returns

If the function succeeds, the return value is a pointer to IBOCreator object. For more details, see IBOCreator, Otherwise failed, the return value is nullptr.

GetBODataHelper()

virtual IBOData * IMeetingBOController::GetBODataHelper ( )

pure virtual

Get the pointer of BO data object.

Returns

If the function succeeds, the return value is a pointer to IBOData object. For more details, see IBOData, Otherwise failed, the return value is nullptr.

GetBOStatus()

virtual BO_STATUS IMeetingBOController::GetBOStatus ( )

pure virtual

Get current BO status.

Returns

The return value is a enum for bo status. For more details, see BO_STATUS.

GetJoiningBOName()

virtual const zchar_t * IMeetingBOController::GetJoiningBOName ( )

pure virtual

Get 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

Determine 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

Determine if the BO is started or not.

Returns

true indicates that host has started the BO, otherwise not.

IsBroadcastingVoiceToBO()

virtual bool IMeetingBOController::IsBroadcastingVoiceToBO ( )

pure virtual

Query if the host is broadcasting voice to BO.

Returns

true means that the host is broadcasting, otherwise it's not broadcasting.

IsInBOMeeting()

virtual bool IMeetingBOController::IsInBOMeeting ( )

pure virtual

Determine 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

Set breakout room callback event handler.

Parameters

event,A

pointer to the IMeetingBOControllerEvent. For more details, see IMeetingBOControllerEvent.

Returns

If the function succeeds, the return value is true. Otherwise false.