Breakout Rooms

Breakout rooms allow participants to split out of the main session for side discussions without leaving the video session entirely. Users in a breakout room are treated as "paused" in the parent room until they return.

• Breakout rooms are available only in Group Mode (not Lecture Mode)
• Only a user in the parent room can create a breakout room; users inside a breakout room cannot create another
• Maximum 10 breakout rooms per parent room
• Maximum participants per breakout room = max_active_talkers of the parent room minus 1
• Breakout rooms support audio calls with screen sharing and canvas streaming; video is not currently supported

Create a Breakout Room

EnxRoom.createBreakOutRoom(JSONObject RoomDefinition) provisions one or more empty breakout room slots on the server. No participants are assigned at this stage — invitation is a separate step. Each created room receives a unique ID used when inviting participants.

JSONObject roomDefinition = new JSONObject();
roomDefinition.put("participants", 2);
roomDefinition.put("audio", true);
roomDefinition.put("video", false);
roomDefinition.put("canvas", false);
roomDefinition.put("share", false);
roomDefinition.put("max_rooms", 1);

enxRoom.createBreakOutRoom(roomDefinition);

public void onAckCreateBreakOutRoom(JSONObject jsonObject) {
    // Creator: breakout room created
    // jsonObject: { msg: { rooms: [xxx] }, result: 0 }
}

public void onBreakoutRoomCreated(JSONObject jsonObject) {
    // All moderators notified
}

Create and Auto-Invite

EnxRoom.createAndInviteBreakoutRoom(JSONObject roomDefinition) combines room creation and participant assignment into a single step. EnableX automatically distributes participants across the created breakout rooms based on capacity — useful when you want to auto-group a large session without managing individual invitations.

The roomDefinition object uses the same parameters as createBreakOutRoom() — see the parameter table above.

enxRoom.createAndInviteBreakoutRoom(roomDefinition);

public void onAckCreateAndInviteBreakOutRoom(JSONObject jsonObject) {
    // Creator: rooms created and users assigned
}

Invite Users to a Breakout Room

EnxRoom.inviteToBreakOutRoom(JSONObject invitee) invites specific participants into a chosen breakout room by client ID. This method must be called from the parent room, not from within a breakout room.

By default, participants receive an invitation they can accept or reject. Set force_join to true to move participants immediately without requiring acceptance (SDK v2.0.1+).

JSONObject invitee = new JSONObject();
JSONArray clients = new JSONArray();
clients.put("clientId1");
invitee.put("clients", clients);
invitee.put("room_id", "BREAKOUT_ROOM_ID");

enxRoom.inviteToBreakOutRoom(invitee);

public void onAckInviteBreakOutRoom(JSONObject jsonObject) {
    // Invitation sent
}

public void onInvitationForBreakoutRoom(JSONObject jsonObject) {
    // Invited user notified
}

public void onBreakoutRoomInvited(JSONObject jsonObject) {
    // Moderators notified
}

Join a Breakout Room

EnxRoom.joinBreakOutRoom(JSONObject Joinee, JSONObject streamInfo) is called by an invited participant to accept and enter a breakout room. The SDK establishes a new session in the breakout room while pausing the participant's presence in the parent room. A participant can only be in one breakout room at a time and can only join from the parent room.

JSONObject joinee = new JSONObject();
joinee.put("role", "participant");
joinee.put("room_id", "BREAKOUT_ROOM_ID");

JSONObject streamInfo = new JSONObject();
streamInfo.put("audio", true);
streamInfo.put("video", false);

enxRoom.joinBreakOutRoom(joinee, streamInfo);

public void onConnectedBreakoutRoom(JSONObject roomMetadata) {
    // Joined breakout room
}

public void onFailedJoinBreakOutRoom(JSONObject jsonObject) {
    // Join failed
}

public void onUserJoinedBreakoutRoom(EnxRoom room, JSONObject jsonObject) {
    // New participant joined
}

Reject a Breakout Room Invitation

EnxRoom.rejectBreakOutRoom(String roomId) declines a breakout room invitation. Pass the room ID received in the onInvitationForBreakoutRoom callback. The moderator is notified so they can take action if needed.

enxRoom.rejectBreakOutRoom("BREAKOUT_ROOM_ID");

public void onAckRejectBreakOutRoom(JSONObject jsonObject) {
    // Rejection acknowledged
}

public void onBreakoutRoomInviteRejected(JSONObject jsonObject) {
    // Moderators notified
}

While active inside a breakout room, a participant still has a presence in the parent room shown as "paused". Your app can explicitly control that parent room presence — pausing, resuming, or muting/unmuting its audio and video independently. This is useful for managing bandwidth or for explicit session control.

Pause the Parent Room

EnxRoom.pause() pauses the parent room audio and video while the user is active in a breakout room.

enxRoom.pause();

public void onAckPause(JSONObject jsonObject) {
    // Parent room paused
    // { "msg": "Room muted", "result": 0 }
}

Resume the Parent Room

EnxRoom.resume() lifts the pause on the parent room, restoring the participant's presence stream.

enxRoom.resume();

public void onAckResume(JSONObject jsonObject) {
    // Parent room resumed
}

Mute the Parent Room

EnxRoom.muteRoom(JSONObject muteInfo) independently mutes audio and/or video in the parent room. This lets you, for example, mute audio while keeping video active.

JSONObject muteInfo = new JSONObject();
muteInfo.put("audio", true);
muteInfo.put("video", true);
enxRoom.muteRoom(muteInfo);

public void onAckMuteRoom(JSONObject jsonObject) {
    // Parent room muted
}

Unmute the Parent Room

EnxRoom.unmuteRoom(JSONObject unmuteInfo) restores audio and/or video in the parent room.

JSONObject unmuteInfo = new JSONObject();
unmuteInfo.put("audio", true);
unmuteInfo.put("video", true);
enxRoom.unmuteRoom(unmuteInfo);

public void onAckUnmuteRoom(JSONObject jsonObject) {
    // Parent room unmuted
}

Disconnect from a Breakout Room

EnxRoom.disconnect() ends the participant's breakout room session. The user is automatically returned to the parent room and their parent room stream resumes.

enxRoom.disconnect();

public void onDisconnectedBreakoutRoom(JSONObject jsonObject) {
    // { "moderatorId": "", "msg": "Breakout Room disconnected", "result": 0 }
}

public void onUserDisconnectedFromBreakoutRoom(EnxRoom room, JSONObject jsonObject) {
    // { "clientId": "String", "name": "String", "room": "..." }
}

Clear All Breakout Rooms

EnxRoom.clearAllBreakOutSession() disconnects all participants from all active breakout instances and returns them to the parent room. The breakout room slots are cleared but not permanently destroyed. Each affected participant receives the onDisconnectedBreakoutRoom callback.

enxRoom.clearAllBreakOutSession();

public void onDisconnectedBreakoutRoom(JSONObject jsonObject) {
    // { "room_id": "String" }
}

Destroy All Breakout Rooms

EnxRoom.destroyAllBreakOutSession() permanently destroys all breakout room sessions. All participants inside any breakout room are disconnected. The parent room is automatically resumed and unmuted for all participants. Each breakout room owner receives the onDisconnectedBreakoutRoom callback.

enxRoom.destroyAllBreakOutSession();

public void onDisconnectedBreakoutRoom(JSONObject jsonObject) {
    // { "room_id": "String" }
}