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
57#ifndef _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
58#define _MEETING_BREAKOUT_ROOMS_INTERFACE2_H_
59#include "zoom_sdk_def.h"
60
61#if defined(WIN32)
62#include "customized_ui/customized_share_render.h"
63#endif
64
66
81
93
99{
100public:
101 virtual ~IBOMeeting() {}
106 virtual const zchar_t* GetBOID() = 0;
107
112 virtual const zchar_t* GetBOName() = 0;
113
119
125 virtual BO_CTRL_USER_STATUS GetBOUserStatus(const zchar_t* strUserID) = 0;
126};
127
129
143
144struct BOOption;
146{
147public:
148 virtual ~IBOCreatorEvent() {}
149
155
160 virtual void OnBOOptionChanged(const BOOption& newOption) = 0;
161
167 virtual void onCreateBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;
168
174 virtual void onRemoveBOResponse(bool bSuccess, const zchar_t* strBOID) = 0;
175
181 virtual void onUpdateBONameResponse(bool bSuccess, const zchar_t* strBOID) = 0;
182};
183
196
265
271{
272public:
279
286 virtual bool AddNewBoToList(const zchar_t* strNewBOName) = 0;
287
294};
295
301{
302public:
303
304 virtual void SetEvent(IBOCreatorEvent* pEvent) = 0;
305
315 virtual bool CreateBreakoutRoom(const zchar_t* strBOName) = 0;
316
323 virtual bool UpdateBOName(const zchar_t* strBOID, const zchar_t* strNewBOName) = 0;
324
330 virtual bool RemoveBO(const zchar_t* strBOID) = 0;
331
338 virtual bool AssignUserToBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
339
346 virtual bool RemoveUserFromBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
347
353 virtual SDKError SetBOOption(const BOOption& option) = 0;
354
360 virtual bool GetBOOption(BOOption& option) = 0;
361
367
372 virtual bool IsWebPreAssignBOEnabled() = 0;
373
379
385
394 virtual bool IsAICompanionSupported() = 0;
395
404 virtual bool IsTranscriptionSupported() = 0;
405};
406
419
425{
426public:
427
428 virtual ~IBOAdminEvent() {}
429
434 virtual void onHelpRequestReceived(const zchar_t* strUserID) = 0;
435
440 virtual void onStartBOError(BOControllerError errCode) = 0;
441
446 virtual void onBOEndTimerUpdated(int remaining, bool isTimesUpNotice) = 0;
447
452 virtual void onStartBOResponse(bool bSuccess) = 0;
453
458 virtual void onStopBOResponse(bool bSuccess) = 0;
459};
460
466{
467public:
472 virtual bool StartBO() = 0;
473
478 virtual bool StopBO() = 0;
479
484 virtual bool AssignNewUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
485
490 virtual bool SwitchAssignedUserToRunningBO(const zchar_t* strUserID, const zchar_t* strBOID) = 0;
491
496 virtual bool CanStartBO() = 0;
497
502 virtual void SetEvent(IBOAdminEvent* pEvent) = 0;
503
508 virtual bool JoinBOByUserRequest(const zchar_t* strUserID) = 0;
509
514 virtual bool IgnoreUserHelpRequest(const zchar_t* strUserID) = 0;
515
520 virtual bool BroadcastMessage(const zchar_t* strMsg) = 0;
521
526 virtual bool InviteBOUserReturnToMainSession(const zchar_t* strUserID) = 0;
527
532 virtual bool IsBroadcastVoiceToBOSupport() = 0;
533
538 virtual bool CanBroadcastVoiceToBO() = 0;
539
545 virtual bool BroadcastVoiceToBo(bool bStart) = 0;
546};
547
549
555{
556public:
561 virtual bool JoinBO(const zchar_t* strBOID) = 0;
562
567 virtual bool LeaveBO() = 0;
568};
569
571
576{
577public:
578
579 virtual ~IBOAttendeeEvent() {}
580
586
590 virtual void onHostJoinedThisBOMeeting() = 0;
591
595 virtual void onHostLeaveThisBOMeeting() = 0;
596};
597
602{
603public:
608 virtual bool JoinBo() = 0;
609
614 virtual bool LeaveBo() = 0;
615
619 virtual const zchar_t* GetBoName() = 0;
620
625 virtual void SetEvent(IBOAttendeeEvent* pEvent) = 0;
626
631 virtual bool RequestForHelp() = 0;
632
637 virtual bool IsHostInThisBO() = 0;
638
643 virtual bool IsCanReturnMainSession() = 0;
644};
645
647
652{
653public:
654 virtual ~IBODataEvent() {}
655
660 virtual void onBOInfoUpdated(const zchar_t* strBOID) = 0;
661
666 virtual void onUnAssignedUserUpdated() = 0;
667
671 virtual void OnBOListInfoUpdated() = 0;
672};
673
678{
679public:
684 virtual void SetEvent(IBODataEvent* pEvent) = 0;
685
691
697
702 virtual const zchar_t* GetBOUserName(const zchar_t* strUserID) = 0;
703
708 virtual bool IsBOUserMyself(const zchar_t* strUserID) = 0;
709
714 virtual IBOMeeting* GetBOMeetingByID(const zchar_t* strBOID) = 0;
715
720 virtual const zchar_t* GetCurrentBoName() = 0;
721};
722
724
741
747{
748public:
750
755 virtual bool ReturnToMainSession() = 0;
756
760 virtual void Ignore() = 0;
761};
762
768{
769public:
771
776 virtual void onHasCreatorRightsNotification(IBOCreator* pCreatorObj) = 0;
777
782 virtual void onHasAdminRightsNotification(IBOAdmin* pAdminObj) = 0;
783
788 virtual void onHasAssistantRightsNotification(IBOAssistant* pAssistantObj) = 0;
789
794 virtual void onHasAttendeeRightsNotification(IBOAttendee* pAttendeeObj) = 0;
795
800 virtual void onHasDataHelperRightsNotification(IBOData* pDataHelperObj) = 0;
801
806
811
816
821
826
832 virtual void onNewBroadcastMessageReceived(const zchar_t* strMsg, unsigned int nSenderID, const zchar_t* strSenderName) = 0;
833
838 virtual void onBOStopCountDown(unsigned int nSeconds) = 0;
839
844 virtual void onHostInviteReturnToMainSession(const zchar_t* strName, IReturnToMainSessionHandler* handler) = 0;
845
850 virtual void onBOStatusChanged(BO_STATUS eStatus) = 0;
851
857 virtual void onBOSwitchRequestReceived(const zchar_t* strNewBOName, const zchar_t* strNewBOID) = 0;
858
863 virtual void onBroadcastBOVoiceStatus(bool bStart) = 0;
864#if defined(WIN32)
872 virtual void onShareFromMainSession(const unsigned int iSharingID, SharingStatus status, IShareAction* pShareAction) = 0;
873#endif
874};
875
881{
882public:
888 virtual bool SetEvent(IMeetingBOControllerEvent* event) = 0;
889
895
901
907
913
918 virtual IBOData* GetBODataHelper() = 0;
919
924 virtual bool IsBOStarted() = 0;
925
930 virtual bool IsBOEnabled() = 0;
931
936 virtual bool IsInBOMeeting() = 0;
937
942 virtual BO_STATUS GetBOStatus() = 0;
943
948 virtual bool IsBroadcastingVoiceToBO() = 0;
949
953 virtual const zchar_t* GetJoiningBOName() = 0;
954};
955
957#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
Starts 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
Determines 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
Sets 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
Leaves 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
Sets attendee callback handler.
virtual bool IsCanReturnMainSession()=0
Determines if participant can return to main session.
virtual bool IsHostInThisBO()=0
Determines 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
Gets name of the BO that attendee is assigned to.
virtual void onCreateBOResponse(bool bSuccess, const zchar_t *strBOID)=0
Callback event of CreateBreakoutRoom.
virtual void OnWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status)=0
Callback event when the pre-assigned data download status changes.
virtual void OnBOOptionChanged(const BOOption &newOption)=0
Callback event when the BO option changes.
virtual void onRemoveBOResponse(bool bSuccess, const zchar_t *strBOID)=0
Callback event of RemoveBO.
virtual void onUpdateBONameResponse(bool bSuccess, const zchar_t *strBOID)=0
Callback event of UpdateBOName.
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
Determines whether web enabled the pre-assigned option when scheduling a meeting.
virtual IBatchCreateBOHelper * GetBatchCreateBOHelper()=0
Gets the Batch create bo controller.
virtual bool GetBOOption(BOOption &option)=0
Gets BO option.
virtual bool IsTranscriptionSupported()=0
Check whether Transcription can be enabled in breakout rooms.
virtual PreAssignBODataStatus GetWebPreAssignBODataStatus()=0
Gets the pre-assigned data download status.
virtual SDKError RequestAndUseWebPreAssignBOList()=0
Request web pre-assigned data and create those rooms.
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 IsAICompanionSupported()=0
Check whether AI Companion can be enabled in breakout rooms.
virtual bool CreateBreakoutRoom(const zchar_t *strBOName)=0
Create a breakout room.
virtual SDKError SetBOOption(const BOOption &option)=0
Set BO option.
BO data callback handler.
virtual void onUnAssignedUserUpdated()=0
To notify if unassigned user join/leave master conference or name is modified.
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
Gets the id list of all unassigned users.
virtual bool IsBOUserMyself(const zchar_t *strUserID)=0
Determines if strUserID is myself.
virtual IList< const zchar_t * > * GetBOMeetingIDList()=0
Gets the id list of all BOs.
virtual const zchar_t * GetBOUserName(const zchar_t *strUserID)=0
Gets user name by user ID.
virtual const zchar_t * GetCurrentBoName()=0
Gets 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
Gets the BO name.
virtual IList< const zchar_t * > * GetBOUserList()=0
Gets the user ID list in the BO.
virtual const zchar_t * GetBOID()=0
Gets the BO ID.
virtual BO_CTRL_USER_STATUS GetBOUserStatus(const zchar_t *strUserID)=0
Gets the 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 attendee 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 assistant right.
virtual void onHasAdminRightsNotification(IBOAdmin *pAdminObj)=0
To notify that you has admin right.
Meeting breakout rooms controller interface.
virtual IBOAssistant * GetBOAssistantHelper()=0
Gets the pointer of BO assistant object.
virtual IBOAdmin * GetBOAdminHelper()=0
Gets the pointer of BO administrator object.
virtual IBOCreator * GetBOCreatorHelper()=0
Gets the pointer of BO creator object.
virtual IBOAttendee * GetBOAttedeeHelper()=0
Gets the pointer of BO attendee object.
virtual BO_STATUS GetBOStatus()=0
Gets current BO status.
virtual bool IsInBOMeeting()=0
Determines if myself is in BO meeting.
virtual bool IsBOStarted()=0
Determines if the BO is started or not.
virtual IBOData * GetBODataHelper()=0
Gets the pointer of BO data object.
virtual bool SetEvent(IMeetingBOControllerEvent *event)=0
Sets breakout room callback event handler.
virtual bool IsBroadcastingVoiceToBO()=0
Query if the host is broadcasting voice to BO.
virtual bool IsBOEnabled()=0
Determines if the BO feature is enabled in current meeting.
virtual const zchar_t * GetJoiningBOName()=0
Gets the name of the BO you are going to. When you enter a BO or are switched to another BO by the ho...
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
PreAssignBODataStatus
Enumeration of BO creator callback handler.
BO_CTRL_USER_STATUS
Enumeration of breakout room user control status.
BO_STOP_COUNTDOWN
Enumeration of BO stop countdown.
BO_STATUS
Enumeration of BO status.
bool IsAttendeeContained
The following items are for Webinar only.
BO_STOP_COUNTDOWN countdown_seconds
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.