BreakoutRoomsModalOptions class

Configuration for the breakout-rooms modal enabling multi-room participant assignment and control.

  • parameters - Must expose participants, breakoutRooms (list of List<BreakoutParticipant>), breakOutRoomStarted, breakOutRoomEnded, canStartBreakout, currentRoomIndex, meetingDisplayType, prevMeetingDisplayType, roomName, shareScreenStarted, shared, socket, localSocket, itemPageLimit, showAlert, and update functions for each state.
  • position - Modal placement via getModalPosition (e.g., 'topRight').
  • backgroundColor - Background color for modal container.

Usage

  1. Host can create up to 10 breakout rooms via "Add Room" button.
  2. Edit room: opens EditRoomModal to assign/unassign participants; modal filters participants by breakoutRooms membership, showing assigned and unassigned lists; drag-drop or click to move participants between rooms.
  3. Delete room: removes room from breakoutRooms, reassigns participants to unassigned pool.
  4. Remove participant: unassigns from specific room while keeping in unassigned pool.
  5. "Start Breakout Rooms" button: validates at least one room with participants, emits startBreakoutRooms socket event, saves prevMeetingDisplayType, sets meetingDisplayType = 'all', updates breakOutRoomStarted = true.
  6. "Stop Breakout Rooms" button: emits stopBreakoutRooms event, restores meetingDisplayType = prevMeetingDisplayType, updates breakOutRoomEnded = true, breakOutRoomStarted = false.
  7. Override via MediasfuUICustomOverrides.breakoutRoomsModal to inject custom room-assignment logic, analytics tracking, or sub-room moderation controls.

Constructors

BreakoutRoomsModalOptions({required bool isVisible, required VoidCallback onBreakoutRoomsClose, required BreakoutRoomsModalParameters parameters, String position = 'topRight', Color backgroundColor = const Color(0xFF83C0E9)})

Properties

backgroundColor Color
Background color of the modal.
final
hashCode int
The hash code for this object.
no setterinherited
isVisible bool
Determines if the modal is visible.
final
onBreakoutRoomsClose VoidCallback
Callback function to close the modal.
final
parameters BreakoutRoomsModalParameters
Parameters for managing breakout rooms.
final
position String
Position of the modal on the screen.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited