MainContainerComponent class

Root container widget wrapping the entire MediaSFU UI surface.

  • Scales dimensions by containerWidthFraction / containerHeightFraction relative to the screen, allowing the experience to occupy a subset of the viewport (e.g., for picture-in-picture or split-screen UIs).
  • Applies margin via legacy fields or the unified margin property, and optional padding, decoration, alignment, and clipBehavior for advanced theming.
  • Renders children inside a Stack so you can layer overlays, debug info, or floating controls atop the experience.

Override this component via MediasfuUICustomOverrides.mainContainer to inject gradients, rounded corners, shadows, or theming providers without replacing the entire layout tree. Commonly used to apply branded backgrounds or wrap the UI in additional context providers.

Notes:

  • The component recalculates dimensions on every build, ensuring responsive behavior during orientation changes or window resizes.
  • When decoration is null, a simple BoxDecoration(color: backgroundColor) is applied.
Inheritance

Constructors

MainContainerComponent.new({Key? key, required MainContainerComponentOptions 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 → MainContainerComponentOptions
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