IMeetingBreakoutRoomsController Class Reference

Breakout Rooms controller interface. More...

#include <meeting_breakout_rooms_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingBreakoutRoomsEvent *pEvent)=0
	Breakout room callback event handler. More...
virtual SDKError	JoinBreakoutRoom (const wchar_t *stBID)=0
	Join the assigned Breakout Room. More...
virtual SDKError	LeaveBreakoutRoom ()=0
	Leave Breakout Room. More...
virtual IList< IBreakoutRoomsInfo *> *	GetBreakoutRoomsInfoList ()=0
	Get the list of the Breakout Rooms. More...

Detailed Description

Breakout Rooms controller interface.

Deprecated:

This interface will be deprecated, please stop using it.

Member Function Documentation

GetBreakoutRoomsInfoList()

virtual IList<IBreakoutRoomsInfo* >* IMeetingBreakoutRoomsController::GetBreakoutRoomsInfoList ( )

pure virtual

Get the list of the Breakout Rooms.

Returns

If the function succeeds, the return is a pointer to the list of Breakout Rooms. For more details, see IBreakoutRoomsInfo. Otherwise failed, the return is NULL.

Remarks

Valid only for ZOOM style user interface mode.

JoinBreakoutRoom()

virtual SDKError IMeetingBreakoutRoomsController::JoinBreakoutRoom ( const wchar_t *  stBID )

pure virtual

Join the assigned Breakout Room.

Parameters

stBID

Specify the Breakout Room ID to join.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks

Valid only for ZOOM style user interface mode.

LeaveBreakoutRoom()

virtual SDKError IMeetingBreakoutRoomsController::LeaveBreakoutRoom ( )

pure virtual

Leave Breakout Room.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks

Valid only for ZOOM style user interface mode.

SetEvent()

virtual SDKError IMeetingBreakoutRoomsController::SetEvent ( IMeetingBreakoutRoomsEvent *  pEvent )

pure virtual

Breakout room callback event handler.

Parameters

pEvent

A pointer to the IMeetingBreakoutRoomsEvent that receives meeting Breakout out room callback event. If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks

The event is used by the SDK to pass the callback event to user's application. If this function is not called or failed, the user's application can not retrieve the callback event.

---

The documentation for this class was generated from the following file:

• h/meeting_service_components/meeting_breakout_rooms_interface.h