Breakout Room helper interface. More...

#include <IWebinarBreakoutRoomHelper.h>

Inherits IWebinarBOCreatorHelper, IWebinarBOAdminHelper, IWebinarBOAssistantHelper, IWebinarBOAttendeeHelper, and IWebinarBODataHelper.

Public Member Functions
virtual	~IWebinarBreakoutRoomHelper ()

virtual ZRCSDKError	RegisterSink (IWebinarBreakoutRoomHelperSink *pSink)=0
	Register webinar breakout room helper callback sink.

virtual ZRCSDKError	DeregisterSink (IWebinarBreakoutRoomHelperSink *pSink)=0
	Deregister webinar breakout room helper callback sink.

virtual IWebinarBOCreatorHelper *	GetBOCreatorHelper ()=0
	Get the pointer of WebinarBO creator object.

virtual IWebinarBOAdminHelper *	GetBOAdminHelper ()=0
	Get the pointer of WebinarBO administrator object.

virtual IWebinarBOAssistantHelper *	GetBOAssistantHelper ()=0
	Get the pointer of WebinarBO assistant object.

virtual IWebinarBOAttendeeHelper *	GetBOAttendeeHelper ()=0
	Get the pointer of WebinarBO attendee object.

virtual IWebinarBODataHelper *	GetBODataHelper ()=0
	Get the pointer of WebinarBO data object.

virtual ZRCSDKError	IsBOEnabled (bool &enabled)=0
	Determine if the WebinarBO feature is enabled in current meeting.

virtual ZRCSDKError	IsBOStarted (bool &started)=0
	Determine if the WebinarBO is started or not.

virtual ZRCSDKError	IsInMainSession (bool &isInMainSession)=0
	Query if you are in main session.

virtual ZRCSDKError	GetBOStatus (BO_STATUS &boStatus)=0
	Query current breakout room status.

Public Member Functions inherited from IWebinarBOCreatorHelper
virtual void	RegisterSink (IWebinarBOCreatorHelperSink *pSink)=0

virtual ZRCSDKError	GetBOOptions (WebinarBOOptions &boOptions)=0
	Get current WebinarBO options.

Public Member Functions inherited from IWebinarBOAdminHelper
virtual void	RegisterSink (IWebinarBOAdminHelperSink *pSink)=0

virtual ZRCSDKError	StopBreakoutRooms ()=0
	Stop all breakout rooms.

Public Member Functions inherited from IWebinarBOAssistantHelper
virtual ZRCSDKError	JoinBreakoutRoom (const std::string &sessionBID)=0
	Join breakout room.

virtual ZRCSDKError	ResponseHostInviteToMainSession (bool accept)=0
	Response host invite to main session when receiving OnHostInviteReturnToMainSession.

Public Member Functions inherited from IWebinarBOAttendeeHelper
virtual ZRCSDKError	JoinBreakoutRoom ()=0
	Join the assigned breakout room.

virtual ZRCSDKError	LeaveBreakoutRoom ()=0
	Leave joined breakout room.

virtual ZRCSDKError	IsCanReturnMainSession (bool &canReturn)=0
	Determine if participant can return to main session.

Public Member Functions inherited from IWebinarBODataHelper
virtual void	RegisterSink (IWebinarBODataHelperSink *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 (const std::string &sessionBID)=0
	Get users info of breakout room.

Detailed Description

Breakout Room helper interface.

Definition at line 365 of file IWebinarBreakoutRoomHelper.h.

Constructor & Destructor Documentation

◆ ~IWebinarBreakoutRoomHelper()

virtual IWebinarBreakoutRoomHelper::~IWebinarBreakoutRoomHelper ( )

inlinevirtual

Definition at line 373 of file IWebinarBreakoutRoomHelper.h.

373{}

Member Function Documentation

◆ DeregisterSink()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::DeregisterSink ( IWebinarBreakoutRoomHelperSink * pSink )

pure virtual

Deregister webinar breakout room helper callback sink.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the IWebinarBreakoutRoomHelperSink that receives the breakout room help callback.

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

◆ GetBOAdminHelper()

virtual IWebinarBOAdminHelper * IWebinarBreakoutRoomHelper::GetBOAdminHelper ( )

pure virtual

Get the pointer of WebinarBO administrator object.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Returns: If the function succeeds, the return value is a pointer to IWebinarBOAdminHelper object. For more details, see IWebinarBOAdminHelper. Otherwise failed, the return value is NULL.

◆ GetBOAssistantHelper()

virtual IWebinarBOAssistantHelper * IWebinarBreakoutRoomHelper::GetBOAssistantHelper ( )

pure virtual

Get the pointer of WebinarBO assistant object.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Returns: If the function succeeds, the return value is a pointer to IWebinarBOAssistantHelper object. For more details, see IWebinarBOAssistantHelper. Otherwise failed, the return value is NULL.

◆ GetBOAttendeeHelper()

virtual IWebinarBOAttendeeHelper * IWebinarBreakoutRoomHelper::GetBOAttendeeHelper ( )

pure virtual

Get the pointer of WebinarBO attendee object.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Returns: If the function succeeds, the return value is a pointer to IWebinarBOAttendeeHelper object. For more details, see IWebinarBOAttendeeHelper. Otherwise failed, the return value is NULL.

◆ GetBOCreatorHelper()

virtual IWebinarBOCreatorHelper * IWebinarBreakoutRoomHelper::GetBOCreatorHelper ( )

pure virtual

Get the pointer of WebinarBO creator object.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Returns: If the function succeeds, the return value is a pointer to IWebinarBOCreatorHelper object. For more details, see IWebinarBOCreatorHelper. Otherwise failed, the return value is NULL.

◆ GetBODataHelper()

virtual IWebinarBODataHelper * IWebinarBreakoutRoomHelper::GetBODataHelper ( )

pure virtual

Get the pointer of WebinarBO data object.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Returns: If the function succeeds, the return value is a pointer to IWebinarBODataHelper object. For more details, see IWebinarBODataHelper. Otherwise failed, the return value is NULL.

◆ GetBOStatus()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::GetBOStatus ( BO_STATUS & boStatus )

pure virtual

Query current breakout room status.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out] boStatus The bo status, see BO_STATUS enum.

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

◆ IsBOEnabled()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::IsBOEnabled ( bool & enabled )

pure virtual

Determine if the WebinarBO feature is enabled in current meeting.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out] enabled TRUE indicates breakout room is enabled in this meeting.

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

◆ IsBOStarted()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::IsBOStarted ( bool & started )

pure virtual

Determine if the WebinarBO is started or not.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out] started TRUE indicates breakout room is started or stopping, see BO_STATUS enum.

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

◆ IsInMainSession()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::IsInMainSession ( bool & isInMainSession )

pure virtual

Query if you are in main session.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out] isInMainSession TRUE indicates you are in main session.

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

◆ RegisterSink()

virtual ZRCSDKError IWebinarBreakoutRoomHelper::RegisterSink ( IWebinarBreakoutRoomHelperSink * pSink )

pure virtual

Register webinar breakout room helper callback sink.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the IWebinarBreakoutRoomHelperSink that receives the breakout room help callback.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IWebinarBreakoutRoomHelper()

Member Function Documentation

◆ DeregisterSink()

◆ GetBOAdminHelper()

◆ GetBOAssistantHelper()

◆ GetBOAttendeeHelper()

◆ GetBOCreatorHelper()

◆ GetBODataHelper()

◆ GetBOStatus()

◆ IsBOEnabled()

◆ IsBOStarted()

◆ IsInMainSession()

◆ RegisterSink()