Breakout Rooms

Breakout rooms allow participants to have focused side discussions outside the main video session. Users in a breakout room are treated as "paused" in the parent room until they return.

• Available in Group Mode only — not in Lecture Mode.
• A user can only create a breakout room from the parent room (not from within another breakout room).
• Maximum 10 breakout rooms per parent session.
• Maximum participants per breakout room = parent room max_active_talkers minus 1.
• Breakout rooms support audio with screen sharing and canvas streaming; video is not currently supported.

Create a Breakout Room

Call createBreakOutRoom: on your EnxRoom instance to create one or more breakout rooms. The creator receives an acknowledgment with the created room details; all moderators in the parent room are notified.

RoomDefinition Parameters

Delegate Methods

NSDictionary *roomDef = @{
    @"participants": @2,
    @"audio": @YES,
    @"video": @NO,
    @"canvas": @NO,
    @"share": @NO,
    @"max_rooms": @1
};

[EnxRoom createBreakOutRoom:roomDef];

- (void)room:(EnxRoom *)room didAckCreateBreakOutRoom:(NSArray *)data {
    // Creator: breakout room created
}

- (void)room:(EnxRoom *)room didBreakoutRoomCreated:(NSArray *)data {
    // All moderators notified
}

Error Codes

Create and Auto-Invite

createAndInviteBreakoutRoom: creates one or more breakout rooms and randomly assigns participants from the parent room — no separate invite step is required. The creator receives a single acknowledgment when rooms are created and users have been distributed.

Accepts the same RoomDefinition parameters as createBreakOutRoom:.

Delegate Methods

[EnxRoom createAndInviteBreakoutRoom:roomDef];

- (void)room:(EnxRoom *)room didAckCreateAndInviteBreakOutRoom:(NSArray *)data {
    // Rooms created and users auto-assigned
}

Error Codes

Invite Users to a Breakout Room

Call inviteToBreakOutRoom: to send one or more participants an invitation to join a specific breakout room. When force_join is true, the invitee is automatically connected without needing to accept the invitation (requires iOS SDK 2.0.1+).

Invitee Parameters

Delegate Methods

NSDictionary *invitee = @{
    @"clients": @[@"clientId1", @"clientId2"],
    @"room_id": @"BREAKOUT_ROOM_ID"
};

[EnxRoom inviteToBreakOutRoom:invitee];

- (void)room:(EnxRoom *)room didAckInviteBreakOutRoom:(NSArray *)data {
    // Invitation sent
}

- (void)room:(EnxRoom *)room didInvitationForBreakoutRoom:(NSArray *)data {
    // Invited users notified
}

- (void)room:(EnxRoom *)room didBreakoutRoomInvited:(NSArray *)data {
    // Moderators notified
}

- (void)room:(EnxRoom *)room didBreakoutroomjoining:(NSArray *)data {
    // Invited participant connected to breakout room
}

Join a Breakout Room

A user can only join a breakout room from the parent room, and can only be in one breakout room at a time. Call joinBreakOutRoom:withStreamInfo: to connect. The streamInfo dictionary specifies the media capabilities to join with.

Parameters

Delegate Methods

NSDictionary *joinee = @{
    @"role": @"participant",
    @"room_id": @"BREAKOUT_ROOM_ID"
};

NSDictionary *streamInfo = @{
    @"audio": @YES,
    @"video": @NO
};

[EnxRoom joinBreakOutRoom:joinee withStreamInfo:streamInfo];

- (void)room:(EnxRoom *)room didConnectedBreakoutRoom:(NSDictionary *)roomMetadata {
    // Joined the breakout room
}

- (void)room:(EnxRoom *)room didFailedJoinBreakOutRoom:(NSArray *)data {
    // Join failed
}

- (void)room:(EnxRoom *)room didUserJoinedBreakoutRoom:(NSArray *)data {
    // New participant joined breakout room
}

Reject a Breakout Room Invitation

Call rejectBreakOutRoom: with the breakout room ID to decline an invitation. The rejection is acknowledged to the user and all moderators are notified.

Delegate Methods

[EnxRoom rejectBreakOutRoom:@"BREAKOUT_ROOM_ID"];

- (void)room:(EnxRoom *)room didAckRejectBreakoutRoom:(NSArray *)data {
    // Rejection acknowledged
}

- (void)room:(EnxRoom *)room didBreakoutRoomInviteRejected:(NSArray *)data {
    // Moderators notified
}

While a breakout session is active, moderators can pause, resume, mute, or unmute the parent room to manage its state independently of the breakout rooms.

Pause the Parent Room

Call pause to pause the parent room while participants are in breakout rooms. The moderator receives an acknowledgment when the room is muted.

Delegate Methods

[EnxRoom pause];

- (void)room:(EnxRoom *)room didAckPause:(NSArray *)data {
    // Parent room paused
    // { "msg": "Room muted", "result": 0 }
}

Resume the Parent Room

Call resume to resume the parent room after it has been paused.

Delegate Methods

[EnxRoom resume];

- (void)room:(EnxRoom *)room didAckResume:(NSArray *)data {
    // Parent room resumed
}

Mute the Parent Room

Call muteRoom: to mute audio, video, or both in the parent room while breakout sessions are running.

muteInfo Parameters

Delegate Methods

NSDictionary *muteInfo = @{ @"audio": @YES, @"video": @YES };
[EnxRoom muteRoom:muteInfo];

- (void)room:(EnxRoom *)room didAckMuteRoom:(NSArray *)data {
    // Parent room muted
}

Unmute the Parent Room

Call unmuteRoom: to restore audio, video, or both in the parent room.

Delegate Methods

NSDictionary *unmuteInfo = @{ @"audio": @YES, @"video": @YES };
[EnxRoom unmuteRoom:unmuteInfo];

- (void)room:(EnxRoom *)room didAckUnmuteRoom:(NSArray *)data {
    // Parent room unmuted
}

Disconnect from a Breakout Room

Call disconnect on the breakout room instance to leave the breakout session. The user is automatically returned to the parent room on disconnect.

Delegate Methods

[EnxRoom disconnect];

- (void)room:(EnxRoom *)room didDisconnectedBreakoutRoom:(NSArray *)data {
    // { "moderatorId": "", "msg": "Breakout Room disconnected", "result": 0 }
}

- (void)room:(EnxRoom *)room didUserDisconnectedFromBreakoutRoom:(NSArray *)data {
    // { "clientId": "String", "name": "String", "room": "..." }
}

Clear All Breakout Rooms

EnxRoom.clearAllBreakOutSession() disconnects all participants from every active breakout room and returns them to the parent room. The breakout room sessions are cleared but not permanently destroyed.

Delegate Methods

- (void)room:(EnxRoom *)room didDisconnectededBreakoutRoom:(NSArray *)data {
    // { "room_id": "String" }
}

Destroy All Breakout Rooms

EnxRoom.destroyAllBreakOutSession() lets the moderator permanently destroy all active breakout rooms. All participants are disconnected from their breakout rooms and returned to the parent room. The parent room is automatically resumed and unmuted after destruction.

Delegate Methods

- (void)room:(EnxRoom *)room didDisconnectedBreakoutRoom:(NSArray *)data {
    // { "room_id": "String" }
}