# Manage breakout rooms

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> The code on this page works with either the **default UI** or the **custom UI**.

Manage breakout room related functionality in the Meeting SDK for Linux. There are five distinct breakout room roles, each with its own associated interface and ability to perform certain pieces of breakout room functionality. Zoom assigns these roles according to a combination of in-client meeting roles and the user's platform.

To know when you can have a user perform a given task, listen for role changes on the `InMeetingBOControllerListener` interface.

## Listen for role changes

To know when the current user's role changes, implement the `IMeetingBOControllerEvent` interface and pass an instance of it into the `inMeetingBOController`.

```cpp
IMeetingBOControllerEventListener* breakoutListener = new IMeetingBOControllerEvent();
meetingService->GetMeetingBOController()->SetEvent(breakoutListener);

.
.
.

void onHasAdminRightsNotification(IBOAdmin* pAdminObj){
boAdmin = pAdminObj;
}

```

This listener has two callbacks associated with each role. One callback indicates that Zoom has assigned the current user to that role, and the other that Zoom has unassigned the user's role. For example, `onHasCreatorRightsNotification` is called when the meeting host has the ability to create breakout rooms. When they no longer have the ability to create breakout rooms, the SDK invokes `onLostCreatorRightsNotification`.

When a user is assigned a breakout room role, the related callback includes a parameter for the interface that exposes the role's functionality. Store a reference to this interface when you receive the callback up until you receive a callback indicating that this role is no longer available.

## The roles

These five roles let users perform the various breakout room functions. Any given user can be assigned to multiple breakout-room roles at a time.

-   [Data](#the-data-role) (`IBOData`) - Access users' data in breakout rooms, including which users are assigned to various breakout rooms, users' names, and breakout rooms' names.
-   [Admin](#the-admin-role) (`IBOAdmin`) - Manages existing breakout rooms and receives help requests from users in breakout rooms.
-   [Creator](#the-creator-role) (`IBOCreator`) - Directly creates and modifies breakout rooms. The creator and admin roles are usually assigned to the same user.
-   [Assistant](#the-assistant-role) (`IBOAssistant`) - The assistant role is a minor role, similar to an attendee. Assistant role holders can join any breakout room directly without being assigned to it.
-   [Attendee](#the-attendee-role) (`IBOAttendee`) - A regular user who can join breakout rooms.

### The data role

When a user receives the `onHasDataHelperRightsNotification` callback, that user can access role-related functionality through `IBOData`.

```cpp
virtual void onHasDataHelperRightsNotification(IBOData* pDataHelperObj){
boData = pDataHelperObj;
 }
```

Rely on the callbacks to determine when `IBOData` is accessible. You can also get an instance directly.

```cpp
IBOData* boData = meetingService->GetMeetingBOController()->GetBODataHelper();
```

The breakout data role receives notifications when data is updated through `IBODataEvent`.

```cpp
IBODataEvent dataEvent = new IBODataEvent() {
       void onBOInfoUpdated(const zchar_t* strBOID) {
        }

        void OnBOListInfoUpdated(){
        }

        void onUnAssignedUserUpdated(){
        }
    };
iboData->SetEvent(dataEvent);
```

#### Data-role tasks

[Get information on breakout rooms](#get-information-on-breakout-rooms), [get user information](#get-user-information)

### The admin role

When a user receives the `onHasAdminRightsNotification` callback, that user can access role-related functionality through `IBOAdmin`.

```cpp
void IMeetingBOControllerEventListener::onHasAdminRightsNotification(IBOAdmin* pAdminObj) {
    boAdmin = pAdminObj
}
```

Rely on the callbacks to determine when `IBOAdmin` is accessible. You can also get an instance directly.

```cpp
IBOAdmin* boAdmin = meetingService->GetMeetingBOController()->GetBOAdminHelper();
```

The breakout admin can receive notifications when other users send a help request through `IBOAdminEvent`.

```cpp
IBOAdminEvent adminEvent = new IBOAdminEvent()
if (boAdmin != nullptr) {
 boAdmin.setEvent(adminEvent);
}
```

#### Admin-role tasks

[Receive users' help requests](#receive-users-help-requests), [assign users to existing breakout rooms](#assign-users-to-existing-breakout-rooms), [broadcast messages into breakout rooms](#broadcast-messages-into-breakout-rooms), [invite users back into the main room](#invite-users-back-into-the-main-room), [respond to help requests from breakout rooms](#respond-to-help-requests-from-breakout-rooms), [start or stop breakout rooms](#start-or-stop-breakout-rooms)

### The creator role

When a user receives the `onHasCreatorRightsNotification` callback, that user can access role-related functionality through `IBOCreator`.

```cpp
public void onHasCreatorRightsNotification(IBOCreator* pCreatorObj){} {
 boCreator = pCreatorObj
}
```

Rely on the callbacks to determine when `IBOCreator` is accessible. You can also get an instance directly.

```cpp
IBOCreator* boCreator = meetingService->GetMeetingBOController()->GetBOCreatorHelper();
```

The breakout creator can receive notifications related to creation of breakout rooms through `IBOCreatorEvent`.

```cpp
IBOCreatorEvent creatorEvent = new IBOCreatorEvent() {
 public void onCreateBOResponse(bool bSuccess, const zchar_t* strBOID) {}

 public void OnWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status) {}
};

if (boCreator != nullptr) {
 boCreator.setEvent(creatorEvent);
}

```

#### Creator-role tasks

[Create a breakout room](#create-a-breakout-room), [manage a breakout room](#manage-a-breakout-room), [preassign users to breakout rooms](#preassign-users-to-breakout-rooms), [configure breakout rooms](#configure-breakout-rooms)

### The assistant role

The assistant role is a minor role similar to an attendee. Assistant role holders can join any breakout room directly without being assigned to it. Use the `breakoutId`, available through `IBOData`, to join a specific room.

```cpp
IBOAssistant boAssistant =  meetingService->GetMeetingBOController()->GetBOAssistantHelper;

if (boAssistant != nullptr) {
    boAssistant.joinBO(breakoutId);
    boAssistant.leaveBO();
}

```

### The attendee role

When a user receives the `onHasAttendeeRightsNotification` callback, that user can access role-related functionality through `IBOAttendee`.

```cpp
public void onHasAttendeeRightsNotification(IBOAttendee* pAttendeeObj) {
    boAttendee = pAttendeeObj;
}

```

Rely on the callbacks to determine when `IBOAttendee` is accessible. You can also get an instance directly.

```cpp
boAttendee = meetingService->GetMeetingBOController()->GetBOAssistantHelper();
```

Breakout attendees receive notifications related to the host's actions through `IBOAttendeeEvent`.

```cpp
IBOAttendeeEvent attendeeEvent = new IBOAttendeeEvent() {
        public void onHelpRequestHandleResultReceived(ATTENDEE_REQUEST_FOR_HELP_RESULT eResult) {
        }

        public void onHostJoinedThisBOMeeting() {
        }

        public void onHostLeaveThisBOMeeting() {
        }
};

if (boAttendee != nullptr) {
    boAttendee.setEvent(attendeeEvent);
}

```

#### Attendee-role tasks

[Join or leave breakout rooms as an attendee](#join-or-leave-breakout-rooms-as-an-attendee), [ask for admin help](#ask-for-admin-help)

## Get information about breakout rooms

Users with the **data role** can perform this task.

Each breakout room is associated with an `IBOMeeting` object and breakout ID. Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasDataHelperRightsNotification` callback](#the-data-role), access a list of breakout rooms at any time and get information about each room.

```cpp
IBOData* boData = meetingService->GetMeetingBOController()->GetBODataHelper();

IList<const zchar_t*>* meetingIDList = boData->GetBOMeetingIDList();
if (meetingIDList != nullptr) {
 for (int i = 0; i < meetingIDList->GetCount(); ++i) {
  const zchar_t* id = meetingIDList->GetItem(i);

  IBOMeeting* ibomeeting = boData->GetBOMeetingByID(id);
  ibomeeting->GetBOID();
  ibomeeting->GetBOName();
  ibomeeting->GetBOUserList();
  ibomeeting->GetBOUserStatus(id);
 }
}

```

## Get user information

Users with the **data role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasDataHelperRightsNotification` callback](#the-data-role), get a list of unassigned users by using `unassignedUserList` to provide a list of IDs. These user IDs are specific to breakout rooms, and can be used to uniquely identify each user. Use this ID to assign that user to a breakout room or to get more data about that user.

```cpp
IList<const zchar_t*>* userList = boData->GetUnassginedUserList();
for (String userId: userList) {
    if (boData != nullptr) {
        boData.getBOUserName(userId);
        boData.isBOUserMyself(userId);
    }
}
```

To get the name of the current user's assigned breakout room, use `currentBoName`.

```cpp
if (boData != nullptr) {
 boData.getCurrentBoName();
}
```

You can also get the user's name based on their breakout user ID.

```cpp
if (boData != nullptr) {
 boData.getBOUserName();
}
```

To see your currently assigned breakout room's name, use `boName`.

```cpp
if (boAttendee != nullptr) {
 boAttendee.getBoName();
}
```

## Receive users' help requests

Users with the **admin role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), admins receive notifications through `IBOAminEvent` when other users send a help request.

```cpp
if (boAttendee != nullptr) {
 boAttendee.getBoName();
}
```

## Assign users to existing breakout rooms

Users with the **admin role** can perform this task.

To assign users to breakout rooms that haven't been started yet, see the creator-role task [Preassign users to breakout rooms](#preassign-users-to-breakout-rooms).

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), assign a user to an existing breakout room by using `assignNewUserToRunningBO`. The `userId` and `breakoutId` are available through `IBOData`.

```cpp
if (boAdmin != nullptr) {
 boAdmin->AssignNewUserToRunningBO(userId, breakoutId);
}
```

To switch an already-assigned user to a different breakout room, use `switchAssignedUserToRunningBO`. The `userId` and `breakoutId` are available through `IBOData`.

```cpp
if (boAdmin != nullptr) {
 boAdmin->SwitchAssignedUserToRunningBO(userId, breakoutId);
}
```

## Broadcast messages into breakout rooms

Users with the **admin role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), broadcast a message to all breakout rooms using `broadcastMessage`.

```cpp
if (boAdmin != nullptr) {
 boAdmin.broadcastMessage(message);
}
```

## Invite users back into the main room

Users with the **admin role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), invite a specific user back into the main meeting by using `inviteBOUserReturnToMainSession`. The `userId` is available through `IBOData`.

```cpp
if (boAdmin != nullptr) {
 boAdmin.broadcastMessage(message);
}
```

## Respond to help requests from breakout rooms

Users with the **admin role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), and after receiving the `onHelpRequestReceived` callback, either accept the request and join that user's breakout room, or ignore it and stay in the current meeting.

```cpp
public void onHelpRequestReceived(String strUserID) {
 if (boAdmin != nullptr) {
 boAdmin.joinBOByUserRequest(strUserID)
 boAdmin.ignoreUserHelpRequest(strUserID)
 }
}
```

## Start or stop breakout rooms

Users with the **admin role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAdminRightsNotification` callback](#the-admin-role), admins can start or stop breakout rooms for the whole meeting.

```cpp
if (boAdmin != nullptr && boAdmin.canStartBO()) {
    boAdmin.startBO()
}

if (boAdmin != nullptr) {
    boAdmin.stopBO()
}

```

## Create a breakout room

Users with the **creator role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasCreatorRightsNotification` callback](#the-creator-role), create a single breakout room by choosing a name for the room and passing it to `createBreakoutRoom`. To batch create breakout rooms, pass a list of names into `createGroupBO`.

```cpp
if (boCreator != nullptr) {
    boCreator.createBreakoutRoom(breakoutName);
    boCreator.createGroupBO(breakoutNameList);
}
```

Once a breakout room is created, you'll receive the `onCreateBOResponse` callback.

After receiving this callback, the creator can now assign and remove users, remove a breakout room, or update the name of an existing room. The `userId` and `breakoutId` used in these methods are available through `IBOData`.

### Receive breakout-room creation notices

Users with the **creator role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasCreatorRightsNotification` callback](#the-creator-role), the creator receives breakout room creation notifications through `IBOCreatorEvent`.

```cpp
creatorEvent = new IBOCreatorEvent() {

        public void onBOCreateSuccess(const zchar_t* strBOID) {
        }

        public void onWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status) {
                    }
    };
if (boCreator != nullptr) {
    boCreator.setEvent(creatorEvent);
}
```

## Manage breakout rooms

Users with the **creator role** can perform these tasks.

Perform any of these tasks once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasCreatorRightsNotification` callback](#the-creator-role).

### Assign users to breakout rooms that haven't yet started

```cpp
if (boCreator != nullptr) {
    boCreator.assignUserToBO(userId, breakoutId);
    boCreator.removeUserFromBO(userId, breakoutId);
}
```

### Remove a breakout room from the list of available rooms

Once breakout rooms are created, you can remove them from the list of available breakout rooms, but the room itself is only ever deleted by Zoom's back end. Developers can't delete breakout rooms.

```cpp
if (boCreator != nullptr) {
    boCreator.removeBO(breakoutId);
}
```

### Change a breakout room's name

```cpp
if (boCreator != nullptr) {
    boCreator.updateBOName(breakoutId, breakoutName);
}
```

## Preassign users to breakout rooms

Users with the **creator role** can perform this task.

To assign users to breakout rooms that are already started, see the admin-role task [Assign users to existing breakout rooms](#assign-users-to-existing-breakout-rooms).

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasCreatorRightsNotification` callback](#the-creator-role), if the meeting allows you to preassign breakout rooms, apply those preassignments through `requestAndUseWebPreAssignBOList`.

```cpp
if (boCreator != nullptr && boCreator.isWebPreAssignBOEnabled()) {
 boCreator.requestAndUseWebPreAssignBOList();
}
```

To get updates on the creation, assignment, or preassignment of breakout rooms, use the `onWebPreAssignBODataDownloadStatusChanged` callback.

```cpp
public void onWebPreAssignBODataDownloadStatusChanged(PreAssignBODataStatus status) {
 switch (status) {
 // Respond to specific statuses here
 }
}
```

## Configure breakout rooms

Users with the **creator role** can perform this task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasCreatorRightsNotification` callback](#the-creator-role), configure breakout rooms by setting the various options through a `BOOption` object.

-   `countdown` - The number of seconds until breakout rooms automatically close for all users.
-   `isAttendeeCanChooseBO` - Whether attendees in a webinar can select their own breakout rooms.
-   `isAttendeeContained` - Whether webinar attendees are allowed to join webinar breakout rooms.
-   `isAutoMoveAllAssignedParticipantsEnabled` - Whether all assigned participants are automatically moved into their respective breakout room.
-   `isBOTimerEnabled` - Whether setting a timer for breakout rooms is enabled.
-   `isPanelistCanChooseBO` - Whether panelists in a webinar can select their own breakout rooms.
-   `isParticipantCanChooseBO` - Whether participants in a meeting can select their own breakout rooms.
-   `isParticipantCanReturnToMainSessionAtAnyTime` - Whether participants in a meeting can return to the main session before the admin has ended breakout rooms.
-   `isTimerAutoStopBOEnabled` - Whether stopping breakout rooms automatically after a set time is supported.
-   `isUserConfigMaxRoomUserLimitsEnabled` - Whether setting a maximum number of users per breakout room is supported.
-   `nUserConfigMaxRoomUserLimits` - The maximum number of users that can join a breakout room, if enabled.
-   `timerDuration` - The amount of time before breakout rooms automatically end, if enabled.

After setting any of these options on the `BOOption` object, update the settings by passing the option setting into the `IBOCreator` instance.

```cpp
BOOption option = new BOOption();
option.countdown = BOStopCountdown.COUNTDOWN_SECONDS_60;
if (boCreator != nullptr) {
    boCreator.setBOOption(option); //delete this line
    SDKError err = boCreator.setBOOption(option); //add these lines
    if (err != SDKERR_SUCCESS)
    {
       //An error occurred during setBOOption.Please refer to the `enum SDKError` for details.
    } //end of updated section
```

Access the current breakout configuration through the same interface.

```cpp
BOOption currentOptions;
if (boCreator != nullptr) {
 currentOptions = boCreator.getBOOption();
}

if (currentOptions.isBOTimerEnabled()) {
 // Timer is enabled and can be set by the creator role
}
```

## Join or leave breakout rooms as an attendee

Users with the **attendee** role can perform these task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAttendeeRightsNotification` callback](#the-attendee-role), join a breakout room by using `joinBo`.

```cpp
if (boAttendee != nullptr) {
 boAttendee.joinBo();
}
```

To leave the current breakout room and return to the main meeting, use `leaveBo`.

```cpp
if (boAttendee != nullptr && boAttendee.isCanReturnMainSession()) {
 boAttendee.leaveBo();
}
```

## Ask for admin help

Users with the **attendee** role can perform these task.

Once you have [listened for the role change](#listen-for-role-changes) and [received the `onHasAttendeeRightsNotification` callback](#the-attendee-role), request help from the breakout room admin by using `requestForHelp`. If the admin is already in the same breakout room as you, you don't need to send a help request.

```cpp
if (boAttendee != nullptr && !boAttendee.isHostInThisBO()) {
 boAttendee.requestForHelp();
}
```

---