DisplaySettingsModal class
DisplaySettingsModalOptions
- Configuration options for the DisplaySettingsModal
.
Properties:
isVisible
: Boolean to determine the visibility of the modal.onClose
: Callback to close the modal.onModifySettings
: Callback to apply changes in display settings.parameters
: Current display settings as aDisplaySettingsModalParameters
object.position
: Position of the modal on the screen (default is 'topRight').backgroundColor
: Background color of the modal (default isColor(0xFF83C0E9)
).
Example Usage:
DisplaySettingsModal(
options: DisplaySettingsModalOptions(
isVisible: true,
onClose: () => print("Modal closed"),
parameters: DisplaySettingsModalParametersImplementation(),
),
);
Display-settings modal controlling participant-grid composition and audiograph visibility.
- Dropdown: "Video Participants Only" (
meetingDisplayType = 'video'
), "Media Participants Only" ('media'
), "Show All Participants" ('all'
). - Three Switch toggles:
- Display Audiographs (
autoWave
): overlays waveform on audio-only tiles. - Force Full Display (
forceFullDisplay
): prevents tile collapse for inactive participants. - Force Video Participants (
meetingVideoOptimized
): prioritizes video tiles in grid.
- Display Audiographs (
- Save button constructs
ModifyDisplaySettingsOptions
and invokesonModifySettings
, which updatesparameters
and triggers re-layout of participant grids. - Positions via
getModalPosition
usingoptions.position
.
Override via MediasfuUICustomOverrides.displaySettingsModal
to inject analytics
tracking, device-specific defaults, or custom display modes (e.g., speaker-focused,
gallery-only, or accessibility-driven layouts).
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DisplaySettingsModal
Constructors
- DisplaySettingsModal({Key? key, required DisplaySettingsModalOptions options})
-
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- options → DisplaySettingsModalOptions
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _DisplaySettingsModalState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited