Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
meeting_breakout_rooms_interface_v2.h File Reference
#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures

class  IBOMeeting
 BO interface. More...
 
class  IBOCreatorEvent
 
struct  BOOption
 BO option. More...
 
class  IBatchCreateBOHelper
 Batch Creater BO helper interface. More...
 
class  IBOCreator
 BO creator interface. More...
 
class  IBOAdminEvent
 BO admin callback handler. More...
 
class  IBOAdmin
 BO admin interface. More...
 
class  IBOAssistant
 BO assistant interface. More...
 
class  IBOAttendeeEvent
 attendee callback handler. More...
 
class  IBOAttendee
 attendee interface More...
 
class  IBODataEvent
 BO data callback handler. More...
 
class  IBOData
 BO data interface. More...
 
class  IReturnToMainSessionHandler
 handler for return to main session. More...
 
class  IMeetingBOControllerEvent
 BO controller callback event handler. More...
 
class  IMeetingBOController
 Meeting breakout rooms controller interface. More...
 

Enumerations

enum  BO_CTRL_USER_STATUS { BO_CTRL_USER_STATUS_UNASSIGNED = 1 , BO_CTRL_USER_STATUS_ASSIGNED_NOT_JOIN = 2 , BO_CTRL_USER_STATUS_IN_BO = 3 , BO_CTRL_USER_STATUS_UNKNOWN = 4 }
 
enum  ATTENDEE_REQUEST_FOR_HELP_RESULT { ATTENDEE_REQUEST_FOR_HELP_RESULT_IDLE , ATTENDEE_REQUEST_FOR_HELP_RESULT_BUSY , ATTENDEE_REQUEST_FOR_HELP_RESULT_IGNORE , ATTENDEE_REQUEST_FOR_HELP_RESULT_HOST_ALREADY_IN_BO }
 
enum  PreAssignBODataStatus { PreAssignBODataStatus_none , PreAssignBODataStatus_downloading , PreAssignBODataStatus_download_ok , PreAssignBODataStatus_download_fail }
 BO creator callback handler. More...
 
enum  BO_STOP_COUNTDOWN {
  BO_STOP_NOT_COUNTDOWN , BO_STOP_COUNTDOWN_SECONDS_10 , BO_STOP_COUNTDOWN_SECONDS_15 , BO_STOP_COUNTDOWN_SECONDS_30 ,
  BO_STOP_COUNTDOWN_SECONDS_60 , BO_STOP_COUNTDOWN_SECONDS_120
}
 enum for BO stop countdown More...
 
enum  BOControllerError {
  BOControllerError_NULL_POINTER = 0 , BOControllerError_WRONG_CURRENT_STATUS , BOControllerError_TOKEN_NOT_READY , BOControllerError_NO_PRIVILEGE ,
  BOControllerError_BO_LIST_IS_UPLOADING , BOControllerError_UPLOAD_FAIL , BOControllerError_NO_ONE_HAS_BEEN_ASSIGNED , BOControllerError_UNKNOWN = 100
}
 
enum  BO_STATUS {
  BO_STATUS_INVALID = 0 , BO_STATUS_EDIT = 1 , BO_STATUS_STARTED = 2 , BO_STATUS_STOPPING = 3 ,
  BO_STATUS_ENDED = 4
}
 enum for BO status More...
 

Enumeration Type Documentation

◆ ATTENDEE_REQUEST_FOR_HELP_RESULT

Enumerator
ATTENDEE_REQUEST_FOR_HELP_RESULT_IDLE 

host receive the help request and there is no other one currently requesting for help

ATTENDEE_REQUEST_FOR_HELP_RESULT_BUSY 

host is handling other's request with the request dialog

ATTENDEE_REQUEST_FOR_HELP_RESULT_IGNORE 

host click "later" button or close the request dialog directly

ATTENDEE_REQUEST_FOR_HELP_RESULT_HOST_ALREADY_IN_BO 

host already in your BO meeting

Definition at line 74 of file meeting_breakout_rooms_interface_v2.h.

75{
@ ATTENDEE_REQUEST_FOR_HELP_RESULT_HOST_ALREADY_IN_BO
host already in your BO meeting
@ ATTENDEE_REQUEST_FOR_HELP_RESULT_IDLE
host receive the help request and there is no other one currently requesting for help
@ ATTENDEE_REQUEST_FOR_HELP_RESULT_IGNORE
host click "later" button or close the request dialog directly
@ ATTENDEE_REQUEST_FOR_HELP_RESULT_BUSY
host is handling other's request with the request dialog

◆ BO_CTRL_USER_STATUS

Enumerator
BO_CTRL_USER_STATUS_UNASSIGNED 

User is in main conference, not assigned to BO.

BO_CTRL_USER_STATUS_ASSIGNED_NOT_JOIN 

User is assigned to BO, but not join.

BO_CTRL_USER_STATUS_IN_BO 

User is already in BO.

BO_CTRL_USER_STATUS_UNKNOWN 

Unknown status.

Definition at line 66 of file meeting_breakout_rooms_interface_v2.h.

67{
@ BO_CTRL_USER_STATUS_UNASSIGNED
User is in main conference, not assigned to BO.
@ BO_CTRL_USER_STATUS_UNKNOWN
Unknown status.
@ BO_CTRL_USER_STATUS_IN_BO
User is already in BO.
@ BO_CTRL_USER_STATUS_ASSIGNED_NOT_JOIN
User is assigned to BO, but not join.

◆ BO_STATUS

enum BO_STATUS

enum for BO status

Enumerator
BO_STATUS_INVALID 

invalid

BO_STATUS_EDIT 

edit & assign

BO_STATUS_STARTED 

BO is started.

BO_STATUS_STOPPING 

stopping BO

BO_STATUS_ENDED 

BO is ended.

Definition at line 531 of file meeting_breakout_rooms_interface_v2.h.

532{
534 BO_STATUS_EDIT = 1,
537 BO_STATUS_ENDED = 4
538};
@ BO_STATUS_EDIT
edit & assign
@ BO_STATUS_STARTED
BO is started.
@ BO_STATUS_STOPPING
stopping BO
@ BO_STATUS_ENDED
BO is ended.

◆ BO_STOP_COUNTDOWN

enum for BO stop countdown

Enumerator
BO_STOP_NOT_COUNTDOWN 
BO_STOP_COUNTDOWN_SECONDS_10 
BO_STOP_COUNTDOWN_SECONDS_15 
BO_STOP_COUNTDOWN_SECONDS_30 
BO_STOP_COUNTDOWN_SECONDS_60 
BO_STOP_COUNTDOWN_SECONDS_120 

Definition at line 151 of file meeting_breakout_rooms_interface_v2.h.

◆ BOControllerError

Enumerator
BOControllerError_NULL_POINTER 
BOControllerError_WRONG_CURRENT_STATUS 
BOControllerError_TOKEN_NOT_READY 
BOControllerError_NO_PRIVILEGE 
BOControllerError_BO_LIST_IS_UPLOADING 
BOControllerError_UPLOAD_FAIL 
BOControllerError_NO_ONE_HAS_BEEN_ASSIGNED 
BOControllerError_UNKNOWN 

Definition at line 301 of file meeting_breakout_rooms_interface_v2.h.

◆ PreAssignBODataStatus

BO creator callback handler.

IBOCreator //////////////////////////////////////////

Enumerator
PreAssignBODataStatus_none 

initial status, no request was sent

PreAssignBODataStatus_downloading 

download in progress

PreAssignBODataStatus_download_ok 

download success

PreAssignBODataStatus_download_fail 

download fail

Definition at line 108 of file meeting_breakout_rooms_interface_v2.h.

109{
114};
@ PreAssignBODataStatus_none
initial status, no request was sent
@ PreAssignBODataStatus_downloading
download in progress
@ PreAssignBODataStatus_download_fail
download fail
@ PreAssignBODataStatus_download_ok
download success