Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IWebinarBreakoutRoomHelper.h File Reference

Webinar Breakout Room interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  WebinarBOOptions
 Webinar breakout room options. More...
 
struct  BreakoutRoomUsersInfo
 Breakout room users. More...
 
class  IWebinarBOCreatorHelperSink
 WebinarBO creator callback handler. More...
 
class  IWebinarBOCreatorHelper
 WebinarBO creator interface. More...
 
class  IWebinarBOAdminHelperSink
 WebinarBO admin callback handler. More...
 
class  IWebinarBOAdminHelper
 WebinarBO admin interface. More...
 
class  IWebinarBOAssistantHelper
 WebinarBO assistant interface. More...
 
class  IWebinarBOAttendeeHelper
 WebinarBO attendee interface. More...
 
class  IWebinarBODataHelperSink
 WebinarBO data callback handler. More...
 
class  IWebinarBODataHelper
 WebinarBO data interface. More...
 
class  IWebinarBreakoutRoomHelperSink
 Breakout Room helper event callback. More...
 
class  IWebinarBreakoutRoomHelper
 Breakout Room helper interface. More...
 

Detailed Description

Webinar Breakout Room interfaces.

Since
Added in ZRC SDK 6.3.5.
 1. WBO are short for Webinar Breakout Room.
 2. Managing WBO (e.g., creating, renaming, or deleting) is not supported yet.
 3. 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_EDIT
 4. Lifecycle
     BO_STATUS_EDIT >>> BO_STATUS_STARTED >>> BO_STATUS_STOPPING >>> BO_STATUS_EDIT
 5. Use Master session and webinarBOStatus.uniqueJoinIndex 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 IWebinarBreakoutRoomHelper.h.