BackgroundModal class

BackgroundModal - Modal for selecting virtual backgrounds.

This component provides an interface for selecting and applying virtual backgrounds during video calls, matching the React MediaSFU implementation.

Features:

  • Default preset images from MediaSFU (wall, shelf, clock, desert, flower)
  • Preset blur backgrounds with adjustable intensity
  • Preset color backgrounds
  • Custom image upload
  • Live camera preview with background applied
  • Platform compatibility checking

Platform Support:

  • ✅ Android: Full support via ML Kit Selfie Segmentation
  • ✅ iOS: Full support via ML Kit Selfie Segmentation
  • ❌ Web: Not supported (no ML Kit)
  • ❌ Windows/macOS/Linux: Not supported (no ML Kit)

Example:

BackgroundModal(
  options: BackgroundModalOptions(
    isVisible: true,
    onClose: () => setState(() => _isVisible = false),
    parameters: backgroundParams,
  ),
)
Inheritance

Constructors

BackgroundModal({Key? key, required BackgroundModalOptions 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 → BackgroundModalOptions
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() → State<BackgroundModal>
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