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

BO attendee interface. More...

#include <IBreakoutRoomHelper.h>

Inherited by IBreakoutRoomHelper.

Public Member Functions

virtual void RegisterSink (IBOAttendeeHelperSink *pSink)=0
 
virtual ZRCSDKError JoinBreakoutRoom ()=0
 Join the assigned breakout room.
 
virtual ZRCSDKError LeaveBreakoutRoom ()=0
 Leave breakout room.
 
virtual ZRCSDKError AskHostForHelpInBO ()=0
 Ask host for help when you are in need in BO.
 
virtual ZRCSDKError IsHostInThisBO (bool &in)=0
 Determine if host is in the BO which attendee is assigned to.
 
virtual ZRCSDKError IsCanReturnMainSession (bool &canReturn)=0
 Determine if participant can return to main session.
 

Detailed Description

BO attendee interface.

Definition at line 431 of file IBreakoutRoomHelper.h.

Member Function Documentation

◆ AskHostForHelpInBO()

virtual ZRCSDKError IBOAttendeeHelper::AskHostForHelpInBO ( )
pure virtual

Ask host for help when you are in need in BO.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsCanReturnMainSession()

virtual ZRCSDKError IBOAttendeeHelper::IsCanReturnMainSession ( bool &  canReturn)
pure virtual

Determine if participant can return to main session.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]canReturnTRUE indicates can return to main session.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsHostInThisBO()

virtual ZRCSDKError IBOAttendeeHelper::IsHostInThisBO ( bool &  in)
pure virtual

Determine if host is in the BO which attendee is assigned to.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]inTRUE indicates host is in current BO.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ JoinBreakoutRoom()

virtual ZRCSDKError IBOAttendeeHelper::JoinBreakoutRoom ( )
pure virtual

Join the assigned breakout room.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ LeaveBreakoutRoom()

virtual ZRCSDKError IBOAttendeeHelper::LeaveBreakoutRoom ( )
pure virtual

Leave breakout room.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual void IBOAttendeeHelper::RegisterSink ( IBOAttendeeHelperSink *  pSink)
pure virtual