IBreakoutRoomHelper.h File Reference

Breakout Room interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	BOOptions
	Breakout room options. More...
class	IBOCreatorHelperSink
	BO creator callback handler. More...
class	IBOCreatorHelper
	BO creator interface. More...
class	IBOAdminHelperSink
	BO admin callback handler. More...
class	IBOAdminHelper
	BO admin interface. More...
class	IBOAssistantHelper
	BO assistant interface. More...
class	IBOAttendeeHelperSink
	BO attendee callback handler. More...
class	IBOAttendeeHelper
	BO attendee interface. More...
class	IBODataHelperSink
	BO data callback handler. More...
class	IBODataHelper
	BO data interface. More...
class	IBreakoutRoomHelperSink
	Breakout Room helper event callback. More...
class	IBreakoutRoomHelper
	Breakout Room helper interface. More...

Enumerations
enum	BO_ASSIGN_PARTICIPANTS_TYPE { ASSIGN_PARTICIPANTS_AUTOMATICALLY = 0 , ASSIGN_PARTICIPANTS_MANUALLY = 1 , LET_PARTICIPANTS_CHOOSE_ROOM = 2 }
	After creating breakout rooms, assign participants type. Here are more detailed structural descriptions. More...
enum	BO_HELP_ATTENDEE_RESULT {   BO_HELP_ATTENDEE_RESULT_UNKNOWN = -1 , BO_HELP_ATTENDEE_RESULT_ACCEPT = 0 , BO_HELP_ATTENDEE_RESULT_BUSY = 1 , BO_HELP_ATTENDEE_RESULT_IGNORE = 2 ,   BO_HELP_ATTENDEE_RESULT_HOST_ALREADY_IN_BO = 3 }
	BO help attendee result. Here are more detailed structural descriptions. More...

Detailed Description

Breakout Room interfaces.

Since

Added in ZRC SDK 6.0.0.

 1. BO or BoR are short for Breakout Room.
 2. BO common work flow
     1) Enter meeting    >>>  BO_STATUS_EDIT
     2) Creates BO       >>>  BO_STATUS_EDIT
     3) Starts  BO       >>>  BO_STATUS_STARTED
     4) Stops   BO       >>>  BO_STATUS_STOPPING
     5) BO is ended      >>>  BO_STATUS_ENDED
 3. Lifecycle
     BO_STATUS_EDIT >>> BO_STATUS_STARTED >>> BO_STATUS_STOPPING >>> BO_STATUS_ENDED
 4. BOParticipantList includes all the breakout rooms and master conference participants.
 5. Use BOParticipantList and userGUID when comparing user between breakout rooms.
 6. Helpers
     1) host in master conference      : creator + admin + assistant + dataHelper
     2) host in BO conference          : admin + assistant + dataHelper
     3) CoHost in master conference    : [attendee] or [creator + admin + assistant + dataHelper]
     4) CoHost in BO conference        : [attendee] or [admin + assistant + dataHelper]
     5) attendee in master conference  : attendee + [assistant + dataHelper]
     6) attendee in BO conference      : attendee + [assistant + dataHelper]

Definition in file IBreakoutRoomHelper.h.

Enumeration Type Documentation

BO_ASSIGN_PARTICIPANTS_TYPE

enum BO_ASSIGN_PARTICIPANTS_TYPE

After creating breakout rooms, assign participants type. Here are more detailed structural descriptions.

Enumerator
ASSIGN_PARTICIPANTS_AUTOMATICALLY	Assign participants to breakout rooms automatically.
ASSIGN_PARTICIPANTS_MANUALLY	Assign participants to breakout rooms manually.
LET_PARTICIPANTS_CHOOSE_ROOM	Let participants choose breakout rooms.

Definition at line 39 of file IBreakoutRoomHelper.h.

{
    ASSIGN_PARTICIPANTS_AUTOMATICALLY = 0,    
    ASSIGN_PARTICIPANTS_MANUALLY = 1,         
    LET_PARTICIPANTS_CHOOSE_ROOM = 2          
};

BO_HELP_ATTENDEE_RESULT

enum BO_HELP_ATTENDEE_RESULT

BO help attendee result. Here are more detailed structural descriptions.

Since

The enum is supported on Zoom Rooms clients with version 6.0.0 or later.

Enumerator
BO_HELP_ATTENDEE_RESULT_UNKNOWN	Invalid.
BO_HELP_ATTENDEE_RESULT_ACCEPT	Host accept attendee's help request.
BO_HELP_ATTENDEE_RESULT_BUSY	Host is handling other's request with the request dialog.
BO_HELP_ATTENDEE_RESULT_IGNORE	Host click "later" button or close the request dialog directly.
BO_HELP_ATTENDEE_RESULT_HOST_ALREADY_IN_BO	Host already in your BO meeting.

Definition at line 402 of file IBreakoutRoomHelper.h.

{
    BO_HELP_ATTENDEE_RESULT_UNKNOWN = -1,             
    BO_HELP_ATTENDEE_RESULT_ACCEPT = 0,               
    BO_HELP_ATTENDEE_RESULT_BUSY = 1,                 
    BO_HELP_ATTENDEE_RESULT_IGNORE = 2,               
    BO_HELP_ATTENDEE_RESULT_HOST_ALREADY_IN_BO = 3    
};