Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_breakout_rooms_interface_v2.h
Go to the documentation of this file.
1
56#ifndef _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
57#define _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
58#include "zoom_sdk_def.h"
59
60#if defined(WIN32)
61#include "customized_ui/customized_share_render.h"
62#endif
63
65
73
81
85{
86public:
87 virtual ~IBOMeeting() {}
88
90 virtual const zchar_t* GetBOID() = 0;
91
93 virtual const zchar_t* GetBOName() = 0;
94
98
101 virtual BO_CTRL_USER_STATUS GetBOUserStatus(const zchar_t* strUserID) = 0;
102};
103
107
115
116struct BOOption;
118{
119public:
120 virtual ~IBOCreatorEvent() {}
121
125 virtual void onBOCreateSuccess(const zchar_t* strBOID) = 0;
126
130
132 virtual void OnBOOptionChanged(const BOOption& newOption) = 0;
133
137 virtual void onCreateBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;
138
142 virtual void onRemoveBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;
143
147 virtual void onUpdateBONameResponse(bool bSuccess, const zchar_t* strBOID) = 0;
148};
149
160
194
198{
199public:
205
211 virtual bool AddNewBoToList(const zchar_t* strNewBOName) = 0;
212
218};
219
223{
224public:
225
226 virtual void SetEvent(IBOCreatorEvent* pEvent) = 0;
227
232 virtual const zchar_t* CreateBO(const zchar_t* strBOName) = 0;
233
241 virtual bool CreateBreakoutRoom(const zchar_t* strBOName) = 0;
242
247 virtual bool UpdateBOName(const zchar_t* strBOID, const zchar_t* strNewBOName) = 0;
248
252 virtual bool RemoveBO(const zchar_t* strBOID) = 0;
253
258 virtual bool AssignUserToBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
259
264 virtual bool RemoveUserFromBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
265
269 virtual bool SetBOOption(const BOOption& option) = 0;
270
274 virtual bool GetBOOption(BOOption& option) = 0;
275
279
282 virtual bool IsWebPreAssignBOEnabled() = 0;
283
288
292
297 virtual bool CreateWebinarBo(const zchar_t* strBOName) = 0;
298};
299
312
316{
317public:
318
319 virtual ~IBOAdminEvent() {}
320
323 virtual void onHelpRequestReceived(const zchar_t* strUserID) = 0;
324
327 virtual void onStartBOError(BOControllerError errCode) = 0;
328
331 virtual void onBOEndTimerUpdated(int remaining, bool isTimesUpNotice) = 0;
332
335 virtual void onStartBOResponse(bool bSuccess) = 0;
336
339 virtual void onStopBOResponse(bool bSuccess) = 0;
340};
341
345{
346public:
349 virtual bool StartBO() = 0;
350
353 virtual bool StopBO() = 0;
354
357 virtual bool AssignNewUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
358
361 virtual bool SwitchAssignedUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
362
365 virtual bool CanStartBO() = 0;
366
369 virtual void SetEvent(IBOAdminEvent* pEvent) = 0;
370
373 virtual bool JoinBOByUserRequest(const zchar_t* strUserID) = 0;
374
377 virtual bool IgnoreUserHelpRequest(const zchar_t* strUserID) = 0;
378
381 virtual bool BroadcastMessage(const zchar_t* strMsg) = 0;
382
385 virtual bool InviteBOUserReturnToMainSession(const zchar_t* strUserID) = 0;
386
389 virtual bool IsBroadcastVoiceToBOSupport() = 0;
390
393 virtual bool CanBroadcastVoiceToBO() = 0;
394
398 virtual bool BroadcastVoiceToBo(bool bStart) = 0;
399};
400
402
406{
407public:
410 virtual bool JoinBO(const zchar_t* strBOID) = 0;
411
414 virtual bool LeaveBO() = 0;
415};
416
418
422{
423public:
424
425 virtual ~IBOAttendeeEvent() {}
426
430
432 virtual void onHostJoinedThisBOMeeting() = 0;
433
435 virtual void onHostLeaveThisBOMeeting() = 0;
436};
440{
441public:
444 virtual bool JoinBo() = 0;
445
448 virtual bool LeaveBo() = 0;
449
451 virtual const zchar_t* GetBoName() = 0;
452
455 virtual void SetEvent(IBOAttendeeEvent* pEvent) = 0;
456
459 virtual bool RequestForHelp() = 0;
460
463 virtual bool IsHostInThisBO() = 0;
464
467 virtual bool IsCanReturnMainSession() = 0;
468};
469
471
475{
476public:
477 virtual ~IBODataEvent() {}
478
481 virtual void onBOInfoUpdated(const zchar_t* strBOID) = 0;
482
485 virtual void onUnAssignedUserUpdated() = 0;
486
489 virtual void OnBOListInfoUpdated() = 0;
490};
494{
495public:
498 virtual void SetEvent(IBODataEvent* pEvent) = 0;
499
504
509
512 virtual const zchar_t* GetBOUserName(const zchar_t* strUserID) = 0;
513
516 virtual bool IsBOUserMyself(const zchar_t* strUserID) = 0;
517
521 virtual IBOMeeting* GetBOMeetingByID(const zchar_t* strBOID) = 0;
522
525 virtual const zchar_t* GetCurrentBoName() = 0;
526};
527
529
539
543{
544public:
546
549 virtual bool ReturnToMainSession() = 0;
550
552 virtual void Ignore() = 0;
553};
554
558{
559public:
561
564 virtual void onHasCreatorRightsNotification(IBOCreator* pCreatorObj) = 0;
565
568 virtual void onHasAdminRightsNotification(IBOAdmin* pAdminObj) = 0;
569
572 virtual void onHasAssistantRightsNotification(IBOAssistant* pAssistantObj) = 0;
573
576 virtual void onHasAttendeeRightsNotification(IBOAttendee* pAttendeeObj) = 0;
577
580 virtual void onHasDataHelperRightsNotification(IBOData* pDataHelperObj) = 0;
581
584
587
590
593
596
600 virtual void onNewBroadcastMessageReceived(const zchar_t* strMsg, unsigned int nSenderID, const zchar_t* strSenderName) = 0;
601
604 virtual void onBOStopCountDown(unsigned int nSeconds) = 0;
605
608 virtual void onHostInviteReturnToMainSession(const zchar_t* strName, IReturnToMainSessionHandler* handler) = 0;
609
612 virtual void onBOStatusChanged(BO_STATUS eStatus) = 0;
613
617 virtual void onBOSwitchRequestReceived(const zchar_t* strNewBOName, const zchar_t* strNewBOID) = 0;
618
621 virtual void onBroadcastBOVoiceStatus(bool bStart) = 0;
622#if defined(WIN32)
628 virtual void onShareFromMainSession(const unsigned int iSharingID, SharingStatus status, IShareAction* pShareAction) = 0;
629#endif
630};
631
635{
636public:
640 virtual bool SetEvent(IMeetingBOControllerEvent* event) = 0;
641
646
651
656
661
665 virtual IBOData* GetBODataHelper() = 0;
666
669 virtual bool IsBOStarted() = 0;
670
673 virtual bool IsBOEnabled() = 0;
674
677 virtual bool IsInBOMeeting() = 0;
678
681 virtual BO_STATUS GetBOStatus() = 0;
682
685 virtual bool IsBroadcastingVoiceToBO() = 0;
686
689 virtual const zchar_t* GetJoiningBOName() = 0;
690};
691
693#endif
BO admin callback handler.
virtual void onStartBOError(BOControllerError errCode)=0
when StartBO fail, you will receive the event.
virtual void onStartBOResponse(bool bSuccess)=0
The callback notification of StartBO.
virtual void onBOEndTimerUpdated(int remaining, bool isTimesUpNotice)=0
if it's timer BO, after start BO, you will receive the event.
virtual void onStopBOResponse(bool bSuccess)=0
The callback notification of StopBO.
virtual void onHelpRequestReceived(const zchar_t *strUserID)=0
when someone send the request help, notify it.
virtual bool BroadcastMessage(const zchar_t *strMsg)=0
To send the broadcast message.
virtual bool IsBroadcastVoiceToBOSupport()=0
Query if the current meeting supports broadcasting host's voice to BO.
virtual bool StartBO()=0
start breakout room, 'IBOAdminEvent.onStartBOResponse' is the corresponding callback notification.
virtual bool SwitchAssignedUserToRunningBO(const zchar_t *strUserID, const zchar_t *strBOID)=0
To Switch user to other BO, when BO is started.
virtual bool IgnoreUserHelpRequest(const zchar_t *strUserID)=0
To ignore the request help.
virtual bool BroadcastVoiceToBo(bool bStart)=0
Start or stop broadcasting voice to BO.
virtual bool InviteBOUserReturnToMainSession(const zchar_t *strUserID)=0
Host invite user return to main session, When BO is started and user is in BO.
virtual bool StopBO()=0
stop breakout room, 'IBOAdminEvent.onStopBOResponse' is the corresponding callback notification.
virtual bool CanStartBO()=0
Determine if can start BO.
virtual bool CanBroadcastVoiceToBO()=0
Query if the host now has the ability to broadcast voice to BO.
virtual void SetEvent(IBOAdminEvent *pEvent)=0
Set admin callback handler.
virtual bool JoinBOByUserRequest(const zchar_t *strUserID)=0
To join the BO which request help is from.
virtual bool AssignNewUserToRunningBO(const zchar_t *strUserID, const zchar_t *strBOID)=0
To set a unassigned user to a BO, when BO is started.
virtual bool JoinBO(const zchar_t *strBOID)=0
Join BO by BO ID.
virtual bool LeaveBO()=0
leave BO
virtual void onHelpRequestHandleResultReceived(ATTENDEE_REQUEST_FOR_HELP_RESULT eResult)=0
To notify the status of request help.
virtual void onHostLeaveThisBOMeeting()=0
To notify if host has leaved the BO.
virtual void onHostJoinedThisBOMeeting()=0
To notify if host has joined the BO.
virtual bool LeaveBo()=0
Leave BO for attendee which is in a BO.
virtual void SetEvent(IBOAttendeeEvent *pEvent)=0
Set attendee callback handler.
virtual bool IsCanReturnMainSession()=0
Determine if participant can return to main session.
virtual bool IsHostInThisBO()=0
Determine if host is in the BO which attendee is assigned to.
virtual bool RequestForHelp()=0
Request help for attendee.
virtual bool JoinBo()=0
Join BO for attendee which is assigned to a BO.
virtual const zchar_t * GetBoName()=0
Get name of the BO that attendee is assigned to.
virtual void onCreateBOResponse(bool bSuccess, const zchar_t *strBOID)=0
The callback notification of CreateBreakoutRoom.
virtual void OnWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status)=0
When the pre-assigned data download status changes, you will receive the event.
virtual void OnBOOptionChanged(const BOOption &newOption)=0
You will receive the event when the option changes.
virtual void onRemoveBOResponse(bool bSuccess, const zchar_t *strBOID)=0
The callback notification of RemoveBO.
virtual void onUpdateBONameResponse(bool bSuccess, const zchar_t *strBOID)=0
The callback notification of UpdateBOName.
virtual void onBOCreateSuccess(const zchar_t *strBOID)=0
If CreateBO successfully, you will receive the event. Make sure you receive the event before start bo...
virtual const zchar_t * CreateBO(const zchar_t *strBOName)=0
Create a BO.
virtual bool UpdateBOName(const zchar_t *strBOID, const zchar_t *strNewBOName)=0
Update BO name, 'IBOCreatorEvent.onUpdateBONameResponse' is the corresponding callback notification.
virtual bool IsWebPreAssignBOEnabled()=0
Determine whether web enabled the pre-assigned option when scheduling a meeting.
virtual IBatchCreateBOHelper * GetBatchCreateBOHelper()=0
Get the Batch create bo controller.
virtual bool SetBOOption(const BOOption &option)=0
Set BO option.
virtual bool GetBOOption(BOOption &option)=0
Get BO option.
virtual PreAssignBODataStatus GetWebPreAssignBODataStatus()=0
Get the pre-assigned data download status.
virtual SDKError RequestAndUseWebPreAssignBOList()=0
Request web pre-assigned data and create those rooms.
virtual bool CreateWebinarBo(const zchar_t *strBOName)=0
Create a Webinar BO, Available Only For Zoomui Mode.
virtual bool RemoveUserFromBO(const zchar_t *strUserID, const zchar_t *strBOID)=0
Remove some user from a BO.
virtual bool AssignUserToBO(const zchar_t *strUserID, const zchar_t *strBOID)=0
Assign a user to a BO.
virtual void SetEvent(IBOCreatorEvent *pEvent)=0
virtual bool RemoveBO(const zchar_t *strBOID)=0
Remove a breakout room, 'IBOCreatorEvent.onRemoveBOResponse' is the corresponding callback notificati...
virtual bool CreateBreakoutRoom(const zchar_t *strBOName)=0
Create a breakout room.
BO data callback handler.
virtual void onUnAssignedUserUpdated()=0
To notify if unassigned user join/leave master conference or name is modified. once you receive the c...
virtual void OnBOListInfoUpdated()=0
Host/CoHost both can edit BO, Host edit BO->start BO->stop BO, then CoHost edit BO->start BO,...
virtual void onBOInfoUpdated(const zchar_t *strBOID)=0
To notify if some BO information is changed(user join/leave BO or BO user name is modified)
virtual IBOMeeting * GetBOMeetingByID(const zchar_t *strBOID)=0
Get BO object by BO ID.
virtual IList< const zchar_t * > * GetUnassignedUserList()=0
Get the id list of all unassigned users.
virtual bool IsBOUserMyself(const zchar_t *strUserID)=0
Determine if strUserID is myself.
virtual IList< const zchar_t * > * GetBOMeetingIDList()=0
Get the id list of all BOs.
virtual const zchar_t * GetBOUserName(const zchar_t *strUserID)=0
Get user name by user ID.
virtual const zchar_t * GetCurrentBoName()=0
Get current BO name if you in a BO.
virtual void SetEvent(IBODataEvent *pEvent)=0
Set BO data callback handler.
virtual const zchar_t * GetBOName()=0
Get BO name.
virtual IList< const zchar_t * > * GetBOUserList()=0
Get user ID list in the BO.
virtual const zchar_t * GetBOID()=0
Get BO ID.
virtual BO_CTRL_USER_STATUS GetBOUserStatus(const zchar_t *strUserID)=0
Get user status by user ID.
Batch Creater BO helper interface.
virtual SDKError CreateBoTransactionCommit()=0
Batch create BO rooms according to the prepare list.
virtual SDKError CreateBOTransactionBegin()=0
Prepare to batch create BO rooms.
virtual bool AddNewBoToList(const zchar_t *strNewBOName)=0
Add the BO name to a prepared list.
BO controller callback event handler.
virtual void onHasCreatorRightsNotification(IBOCreator *pCreatorObj)=0
To notify that you has creator right.
virtual void onHasDataHelperRightsNotification(IBOData *pDataHelperObj)=0
To notify that you has data right.
virtual void onLostDataHelperRightsNotification()=0
To notify that you lost data right.
virtual void onNewBroadcastMessageReceived(const zchar_t *strMsg, unsigned int nSenderID, const zchar_t *strSenderName)=0
To notify that you receive a broadcast message.
virtual void onLostAttendeeRightsNotification()=0
To notify that you lost attendee right.
virtual void onLostCreatorRightsNotification()=0
To notify that you lost creator right.
virtual void onBOStatusChanged(BO_STATUS eStatus)=0
When host change the BO status, all users receive the event.
virtual void onBOStopCountDown(unsigned int nSeconds)=0
When BOOption.countdown_seconds != BO_STOP_NOT_COUNTDOWN, host stop BO and all users receive the even...
virtual void onBOSwitchRequestReceived(const zchar_t *strNewBOName, const zchar_t *strNewBOID)=0
Whenever the host switches you to another BO while you are assigned but haven't joined the BO,...
virtual void onHasAssistantRightsNotification(IBOAssistant *pAssistantObj)=0
To notify that you has assistant right.
virtual void onLostAdminRightsNotification()=0
To notify that you lost admin right.
virtual void onBroadcastBOVoiceStatus(bool bStart)=0
The status of broadcasting voice to BO has been changed.
virtual void onHostInviteReturnToMainSession(const zchar_t *strName, IReturnToMainSessionHandler *handler)=0
When you are in BO, host invite you return to main session, you will receive the event.
virtual void onLostAssistantRightsNotification()=0
To notify that you lost assistant right.
virtual void onHasAttendeeRightsNotification(IBOAttendee *pAttendeeObj)=0
To notify that you has attendee right.
virtual void onHasAdminRightsNotification(IBOAdmin *pAdminObj)=0
To notify that you has admin right.
Meeting breakout rooms controller interface.
virtual IBOAssistant * GetBOAssistantHelper()=0
Get the pointer of BO assistant object.
virtual IBOAdmin * GetBOAdminHelper()=0
Get the pointer of BO administrator object.
virtual IBOCreator * GetBOCreatorHelper()=0
Get the pointer of BO creator object.
virtual IBOAttendee * GetBOAttedeeHelper()=0
Get the pointer of BO attendee object.
virtual BO_STATUS GetBOStatus()=0
Get current BO status.
virtual bool IsInBOMeeting()=0
Determine if myself is in BO meeting.
virtual bool IsBOStarted()=0
Determine if the BO is started or not.
virtual IBOData * GetBODataHelper()=0
Get the pointer of BO data object.
virtual bool SetEvent(IMeetingBOControllerEvent *event)=0
Set breakout room callback event handler.
virtual bool IsBroadcastingVoiceToBO()=0
Query if the host is broadcasting voice to BO.
virtual bool IsBOEnabled()=0
Determine if the BO feature is enabled in current meeting.
virtual const zchar_t * GetJoiningBOName()=0
Get the name of the BO you are going to. When you enter a BO or are switched to another BO by the hos...
handler for return to main session.
virtual bool ReturnToMainSession()=0
return to main session.
virtual void Ignore()=0
Ignore the return invitation, after call 'Ignore()', please don't use the handler unless you receive ...
@ 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
PreAssignBODataStatus
BO creator callback handler.
@ PreAssignBODataStatus_none
initial status, no request was sent
@ PreAssignBODataStatus_downloading
download in progress
@ PreAssignBODataStatus_download_fail
download fail
@ PreAssignBODataStatus_download_ok
download success
@ 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_STOP_COUNTDOWN
enum for BO stop countdown
BO_STATUS
enum for BO status
@ BO_STATUS_EDIT
edit & assign
@ BO_STATUS_STARTED
BO is started.
@ BO_STATUS_STOPPING
stopping BO
@ BO_STATUS_ENDED
BO is ended.
bool IsTimerAutoStopBOEnabled
true: if time is up, will stop BO auto. false: don't auto stop. Only for Meeting not Webinar.
bool IsPanelistCanChooseBO
Enable/Disable that Panelist can choose breakout room.
bool IsUserConfigMaxRoomUserLimitsEnabled
Enable/Disable that max roomUser limits in BO room.
bool IsAutoMoveAllAssignedParticipantsEnabled
Enable/Disable that auto move all assigned participants to breakout room.
bool IsAttendeeCanChooseBO
Enable/Disable that Attendee can choose breakout room, invalid when attendee is not contained.
bool IsAttendeeContained
The following items are for Webinar only.
BO_STOP_COUNTDOWN countdown_seconds
Set the countdown after closing breakout room.
unsigned int nTimerDuration
seconds of BO timer duration, NOTE: when nTimerDuration is 0, it means that the BO duration is 30*60 ...
bool IsParticipantCanReturnToMainSessionAtAnyTime
Enable/Disable that participant can return to main session at any time.
bool IsParticipantCanChooseBO
Enable/Disable that participant can choose breakout room. Only for Meeting not Webinar.
bool IsBOTimerEnabled
true: it's timer BO false: not timer BO
unsigned int nUserConfigMaxRoomUserLimits
numbers of max roomUser limits in BO room.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.
SharingStatus
Enumeration of sharing status.