MediaSettingsModal class

MediaSettingsModalOptions - Configuration options for the MediaSettingsModal.

  • isVisible: Boolean to control modal visibility.
  • onClose: Callback function to handle modal close.
  • switchCameraOnPress: Function to handle camera switch action.
  • switchVideoOnPress: Function to handle video switch action.
  • switchAudioOnPress: Function to handle audio switch action.
  • parameters: Instance of MediaSettingsModalParameters.
  • position: Modal position on the screen (e.g., 'topRight').
  • backgroundColor: Background color of the modal.

Example Usage:

MediaSettingsModal(
  options: MediaSettingsModalOptions(
    isVisible: true,
    onClose: () => print("Modal closed"),
    parameters: CustomMediaSettingsModalParameters(),
    backgroundColor: Colors.blue,
  ),
);

Device-picker modal for camera/mic selection and mobile camera flipping.

  • Builds dropdowns from parameters.videoInputs and parameters.audioInputs (list of MediaDeviceInfo from flutter_webrtc).
  • Current selection defaults to userDefaultVideoInputDevice and userDefaultAudioInputDevice.
  • Dropdown changes invoke switchVideoOnPress or switchAudioOnPress, which call switchVideo/switchAudio to update tracks, then persist new deviceId to userDefaultVideoInputDevice/userDefaultAudioInputDevice.
  • "Switch Camera" button (mobile-only) calls switchCameraOnPress (defaults to switchVideoAlt), toggling front/back cameras.
  • Positions via getModalPosition using options.position.
  • Offers seven builder hooks (wrapperBuilder, containerBuilder, headerBuilder, sectionBuilder, dropdownBuilder, buttonBuilder) plus customBuilder for full replacement, enabling custom device previews, permission prompts, or QR-based device linking.

Override via MediasfuUICustomOverrides.mediaSettingsModal to inject live preview tiles, device aliases, or permission checks.

Inheritance

Constructors

MediaSettingsModal.new({Key? key, required MediaSettingsModalOptions 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 MediaSettingsModalOptions
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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