Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
Public Member Functions
IBreakoutRoomHelperSink Class Referenceabstract

Breakout Room helper event callback. More...

#include <IBreakoutRoomHelper.h>

Public Member Functions

virtual ~IBreakoutRoomHelperSink ()
 
virtual void OnBOStatusChanged (BO_STATUS boStatus)=0
 Breakout room status changed notification.
 
virtual void OnBOSwitchRequestReceived (const std::string &fromUserName, const BreakoutRoomInfo &newBORoomInfo)=0
 Receive switch to breakout room request.
 
virtual void OnHostInviteReturnToMainSession (const std::string &fromUserName)=0
 Host invite you to return to main session notification.
 
virtual void OnBOStopCountDown (uint64_t remainingSeconds)=0
 BO stop countdown, if BO enable countdown, you will receive this notification when bo is stopping, see BO_STOP_COUNTDOWN enum.
 
virtual void OnStartJoinBONotification ()=0
 Start to join BO notification.
 

Detailed Description

Breakout Room helper event callback.

Definition at line 615 of file IBreakoutRoomHelper.h.

Constructor & Destructor Documentation

◆ ~IBreakoutRoomHelperSink()

virtual IBreakoutRoomHelperSink::~IBreakoutRoomHelperSink ( )
inlinevirtual

Definition at line 618 of file IBreakoutRoomHelper.h.

618{}

Member Function Documentation

◆ OnBOStatusChanged()

virtual void IBreakoutRoomHelperSink::OnBOStatusChanged ( BO_STATUS  boStatus)
pure virtual

Breakout room status changed notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
boStatusNew BO status, see BO_STATUS enum.

◆ OnBOStopCountDown()

virtual void IBreakoutRoomHelperSink::OnBOStopCountDown ( uint64_t  remainingSeconds)
pure virtual

BO stop countdown, if BO enable countdown, you will receive this notification when bo is stopping, see BO_STOP_COUNTDOWN enum.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
remainingSecondsThe bo stop countdown remaining time in seconds.

◆ OnBOSwitchRequestReceived()

virtual void IBreakoutRoomHelperSink::OnBOSwitchRequestReceived ( const std::string &  fromUserName,
const BreakoutRoomInfo &  newBORoomInfo 
)
pure virtual

Receive switch to breakout room request.

Since
6.0.0
Zoom Rooms minimum version
6.0.0

Whenever the host switches you to another BO while you are assigned but haven't joined the BO, you will receive this event.

Parameters
fromUserNameThe request from user's name, empty string indicates from host.
newBORoomInfoThe new BO room info.

◆ OnHostInviteReturnToMainSession()

virtual void IBreakoutRoomHelperSink::OnHostInviteReturnToMainSession ( const std::string &  fromUserName)
pure virtual

Host invite you to return to main session notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
fromUserNameThe request from user's name, empty string indicates from host.

◆ OnStartJoinBONotification()

virtual void IBreakoutRoomHelperSink::OnStartJoinBONotification ( )
pure virtual

Start to join BO notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0