IBODataHelper Class Reference

BO data interface. More...

#include <IBreakoutRoomHelper.h>

Inherited by IBreakoutRoomHelper.

Public Member Functions
virtual void	RegisterSink (IBODataHelperSink *pSink)=0
virtual ZRCSDKError	GetBOUserStatus (BO_USER_STATUS &boUserStatus)=0
	Query self breakout room user status.
virtual ZRCSDKError	GetBreakoutRoomList (std::vector< BreakoutRoomInfo > &boRoomList)=0
	Get all breakout room info list.
virtual ZRCSDKError	GetBreakoutRoomUserList (std::vector< MeetingParticipant > &userList)=0
	Get all breakout rooms' user list.

Detailed Description

BO data interface.

Definition at line 567 of file IBreakoutRoomHelper.h.

Member Function Documentation

GetBOUserStatus()

virtual ZRCSDKError IBODataHelper::GetBOUserStatus ( BO_USER_STATUS &  boUserStatus )

pure virtual

Query self breakout room user status.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

boUserStatus

Self bo user status, see BO_USER_STATUS enum.

Returns

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

GetBreakoutRoomList()

virtual ZRCSDKError IBODataHelper::GetBreakoutRoomList ( std::vector< BreakoutRoomInfo > &  boRoomList )

pure virtual

Get all breakout room info list.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

boRoomList

All bo room info list.

Returns

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

GetBreakoutRoomUserList()

virtual ZRCSDKError IBODataHelper::GetBreakoutRoomUserList ( std::vector< MeetingParticipant > &  userList )

pure virtual

Get all breakout rooms' user list.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

The BO user list contains all users of breakout rooms, including main session. Check user breakout room status with MeetingParticipant.BreakoutRoomStatus

Parameters

[out]

userList

All breakout rooms' user list.

Returns

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

RegisterSink()

virtual void IBODataHelper::RegisterSink ( IBODataHelperSink *  pSink )

pure virtual