DisplaySettingsModalOptions class

Configuration for the display-settings modal controlling participant-grid behavior.

  • onModifySettings - Override for modifyDisplaySettings; receives {settings, parameters}. Applies changes to meetingDisplayType, autoWave, forceFullDisplay, meetingVideoOptimized.
  • parameters - Must expose meetingDisplayType (current selection: 'video', 'media', or 'all'), autoWave, forceFullDisplay, meetingVideoOptimized.
  • position - Modal placement via getModalPosition (e.g., 'topRight').
  • backgroundColor - Background color for modal container.

Compatible with ModernDisplaySettingsModalOptions from the modern component.

Usage

  1. "Display Option" dropdown: 'video' = video-only participants, 'media' = only those with active audio/video, 'all' = everyone including listeners.
  2. "Display Audiographs" switch: enables waveform overlays on audio-only tiles.
  3. "Force Full Display" switch: prevents tile collapse for inactive participants.
  4. "Force Video Participants" switch: prioritizes video tiles in grid layout.
  5. Save button invokes onModifySettings with new values, updating parameters.
  6. Override via MediasfuUICustomOverrides.displaySettingsModal to inject analytics tracking, device-specific defaults, or custom display modes.

Constructors

DisplaySettingsModalOptions({required bool isVisible, required VoidCallback onClose, ModifyDisplaySettingsType onModifySettings = modifyDisplaySettings, required DisplaySettingsModalParameters parameters, String position = 'topRight', Color backgroundColor = const Color(0xFF83C0E9), bool isDarkMode = false, bool enableGlassmorphism = false, ModalRenderMode renderMode = ModalRenderMode.modal})

Properties

backgroundColor Color
final
enableGlassmorphism bool
Enable glassmorphism effects for modern styling. Note: Pending modern implementation - placeholder for future glassmorphic UI.
final
hashCode int
The hash code for this object.
no setterinherited
isDarkMode bool
Dark mode toggle for modern styling. Note: Pending modern implementation - placeholder for future glassmorphic UI.
final
isVisible bool
final
onClose VoidCallback
final
onModifySettings ModifyDisplaySettingsType
final
parameters DisplaySettingsModalParameters
final
position String
final
renderMode ModalRenderMode
Render mode for embedding in different contexts.
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