components library

Classes

AlertComponent
Full-screen alert overlay displaying success/error messages with auto-dismiss and tap-to-dismiss.
AnimatedCrossfade
A widget that animates between two children with a crossfade effect.
AnimatedEntry
A widget that animates a single child with slide and fade animation.
AnimatedGradientBackground
An animated gradient background that smoothly transitions between colors.
AnimatedGradientBorderContainer
A container with an animated rotating gradient border.
AnimatedGradientBorderPainter
Custom painter for animated rotating gradient borders.
AnimatedIconButton
Micro-animated icon button used for control surfaces (mic, camera, etc.).
AnimatedModal
A widget that provides a scale + fade animation for modals.
AudioCard
A stateful widget displaying audio-only participant card with animated waveform and controls.
AudioGrid
A stateless widget rendering audio-only participant cards in a Stack layout.
AuroraBackground
A simple aurora-style animated background.
BackgroundModal
BackgroundModal - Modal for selecting virtual backgrounds.
BackgroundModalOptions
Options for the BackgroundModal widget.
BounceIn
A widget that bounces in when first displayed.
BreakoutRoomsModal
Breakout-rooms modal enabling multi-room participant assignment, editing, and session control.
CardVideoDisplay
A stateful widget rendering WebRTC video streams with advanced lifecycle management.
CoHostModal
CoHostModal - A modal widget for managing co-host settings.
ConfigureWhiteboardModal
ConfigureWhiteboardModal - Modal for configuring and managing whiteboard sessions.
ConfigureWhiteboardModalOptions
Options for the ConfigureWhiteboardModal widget.
ConfirmExitModal
ConfirmExitModalOptions - Configuration options for ConfirmExitModal.
ConfirmHereModal
Presence-confirmation modal with countdown timer, auto-dismiss, and manual confirm button.
ControlButtonsAltComponent
A stateless widget rendering an alternative control button bar with flexible positioning.
ControlButtonsComponent
Control-buttons bar displaying action buttons with icon/label, active states, and horizontal/vertical layout.
ControlButtonsComponentTouch
A stateless widget rendering touch-optimized control buttons with extensive customization.
DisplaySettingsModal
DisplaySettingsModalOptions - Configuration options for the DisplaySettingsModal.
EventSettingsModal
EventSettingsModalOptions - Configuration options for EventSettingsModal.
FlexibleGrid
A responsive grid widget built specifically for the MediaSFU UI surface.
FlexibleVideo
Responsive video-grid widget that powers MediaSFU's main participant layout.
GlassmorphicContainer
Reusable frosted glass surface used for overlays and floating UI.
GlowBorderContainer
A container with a glowing border.
GlowBorderPainter
Custom painter for glowing borders.
GlowCard
A glowing card variant with optional gradient background.
GlowContainer
A container with customizable glowing effects.
GlowIndicator
A circular glowing indicator/badge.
GradientBorderContainer
A container with a gradient border.
GradientBorderPainter
Custom painter for gradient borders.
GradientCard
Elevated gradient card used for hero sections and highlight tiles.
LoadingModal
Full-screen loading overlay blocking interaction during async operations.
MainAspectComponent
A stateful widget rendering the primary responsive video area with real-time screen size detection.
MainContainerComponent
Root container widget wrapping the entire MediaSFU UI surface.
MainGridComponent
A stateless widget rendering the main participant video grid with optional timer overlay.
MainScreenComponent
Adaptive layout widget powering MediaSFU's spotlight/gallery split.
MediaSettingsModal
MediaSettingsModalOptions - Configuration options for the MediaSettingsModal.
MediasfuBorders
Border utilities for the modern MediaSFU UI.
MediasfuBroadcast
MediasfuBroadcast - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuChat
MediasfuChat - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuColors
Design tokens representing the modern MediaSFU colour palette.
MediasfuConference
MediasfuConference - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuGeneric
MediasfuGeneric - A generic widget for initializing and managing Mediasfu functionalities.
MediasfuSpacing
Defines the canonical spacing scale for the modern MediaSFU UI.
MediasfuTheme
Factory for the modern MediaSFU ThemeData variants.
MediasfuThemeModeNotifier
Simple notifier used to switch between light/dark/system themes.
MediasfuTypography
Typography scale derived from the redesign specification.
MediasfuWebinar
MediasfuWebinar - A generic widget for initializing and managing Mediasfu functionalities.
MeetingProgressTimer
MeetingProgressTimer - Displays the meeting progress time with extensive customization hooks.
MenuModalOptions - Configuration options for the MenuModal widget.
MeshGradientBackground
A mesh gradient background with multiple focal points.
MessagesModal
Tabbed chat interface distinguishing direct messages from group broadcast.
MiniAudio
MiniAudioPlayer
A Flutter widget for playing audio streams with optional waveform visualization.
MiniCard
A compact avatar/badge widget displaying participant image or initials.
ModalFooterButton
A full-width gradient action button for modern modal footers.
ModalGradientDivider
A horizontal gradient divider used between modal sections.
ModalHeader
Reusable modal header with gradient icon, title, and close button.
ModernAdvancedPanelComponent
A modern advanced recording configuration panel with glassmorphic styling.
ModernAdvancedPanelComponentOptions
Configuration options for ModernAdvancedPanelComponent. Uses the same AdvancedPanelComponentParameters as the original component.
ModernAlertComponent
Modern redesigned AlertComponent with glassmorphic styling, premium animations, and glow effects for success/error states.
ModernAudioCard
A modern audio-only participant card with glassmorphic design, animated waveform visualization, and smooth animations. Uses the same AudioCardOptions as the original component.
ModernAudioDecibelCheck
ModernAudioDecibelCheck - A utility widget that periodically checks audio decibel levels and adjusts waveform visibility through callbacks.
ModernAudioDecibelCheckOptions
Configuration options for the ModernAudioDecibelCheck widget.
ModernBackgroundModal
Modern background modal with glassmorphic design. Uses the same BackgroundModalOptions as the original component.
ModernBreakoutRoomsModal
Modern glassmorphic breakout rooms management modal.
ModernCardVideoDisplay
A modern video display widget with glassmorphic styling and smooth animations.
ModernCardVideoDisplayContainerContext
Provides context data when building a custom container for ModernCardVideoDisplay.
ModernCardVideoDisplayOptions
Configuration options for the modern CardVideoDisplay widget.
ModernCardVideoDisplayVideoContext
Provides context data when building a custom video surface for ModernCardVideoDisplay.
ModernCoHostModal
Modern glassmorphic co-host management modal.
ModernConfirmExitModal
Modern glassmorphic confirm exit modal with smooth animations.
ModernConfirmHereModal
Modern redesigned ConfirmHereModal with glassmorphic styling and circular countdown. Retains all business logic from the original component.
ModernControlButtonsComponent
Modern replacement for ControlButtonsComponent.
ModernCustomButton
ModernCustomButton - Defines options for each button within ModernCustomButtons.
ModernCustomButtons
ModernCustomButtons - A modern widget displaying a list of customizable buttons.
ModernCustomButtonsOptions
ModernCustomButtonsOptions - Configuration options for multiple buttons.
ModernDisplaySettingsModal
Modern display settings modal with glassmorphic design. Uses the same DisplaySettingsModalOptions as the original component.
ModernEventSettingsModal
Modern event settings modal with glassmorphic design. Uses the same EventSettingsModalOptions as the original component.
ModernFlexibleGrid
Modern styled flexible grid that accepts FlexibleGridOptions. Provides modern visual treatment while maintaining API compatibility with the original FlexibleGrid.
ModernLoadingModal
Modern redesigned LoadingModal with glassmorphic styling, gradient spinner, and premium animations.
ModernMainContainerComponent
Modern redesigned MainContainerComponent with glassmorphic styling. Retains all business logic from the original component.
ModernMediaSettingsModal
Modern media settings modal with glassmorphic design. Uses the same MediaSettingsModalOptions as the original component.
ModernMediasfuGeneric
MediasfuGeneric - A generic widget for initializing and managing Mediasfu functionalities.
ModernMediasfuGenericHead
Renders the exact modern interface owned by an already-mounted ModernMediasfuGeneric room engine.
ModernMediasfuGenericOptions
ModernMeetingIdComponent
A modern glassmorphic widget displaying a read-only meeting/event ID.
ModernMeetingIdComponentOptions
Configuration options for the ModernMeetingIdComponent widget.
ModernMeetingPasscodeComponent
A modern glassmorphic widget displaying a read-only meeting passcode.
ModernMeetingPasscodeComponentOptions
Configuration options for the ModernMeetingPasscodeComponent widget.
ModernMeetingProgressTimer
ModernMeetingProgressTimer - Displays the meeting progress time with glassmorphic styling.
ModernMenuModal
Modern redesigned MenuModal with glassmorphic styling, premium animations, theme selector, and enhanced visual effects.
ModernMessagePanel
A modern glassmorphic message panel with smooth animations and refined styling.
ModernMessagePanelOptions
Configuration options for the modern message panel.
ModernMessagesModal
Modern tabbed chat interface with glassmorphic design. Uses the same MessagesModalOptions as the original component.
ModernMiniAudioPlayer
A modern Flutter widget for playing audio streams with glassmorphic styling.
ModernMiniAudioPlayerOptions
Options for ModernMiniAudioPlayer.
ModernMiniAudioPlayerParameters
Parameters for ModernMiniAudioPlayer.
ModernMiniCard
A modern compact avatar/badge widget with glassmorphic styling.
ModernPagination
Modern styled pagination that accepts PaginationOptions. Provides glassmorphic styling and modern visual treatment while maintaining API compatibility with the original Pagination.
ModernPanelistsModal
ModernPanelistsModal - Premium styled modal for managing panelists.
ModernPanelistsModalOptions
Options for the ModernPanelistsModal widget
ModernParticipantList
A modern participant list with glassmorphic styling.
ModernParticipantListOptions
Configuration options for ModernParticipantList
ModernParticipantListOthers
A modern read-only participant list for viewing other participants.
ModernParticipantListOthersOptions
Configuration options for ModernParticipantListOthers
ModernParticipantsModal
Modern participants modal with glassmorphic design. Uses the same ParticipantsModalOptions as the original component.
ModernPermissionsModal
ModernPermissionsModal - Premium styled modal for managing participant permissions.
ModernPermissionsModalOptions
Options for the ModernPermissionsModal widget
ModernPollModal
Modern poll modal with glassmorphic design. Uses the same PollModalOptions as the original component.
ModernPreJoinPage
Modern redesigned PreJoinPage with identical business logic. Only the UI layer is modernized; all callbacks and socket logic remain unchanged.
ModernPressable
The interaction primitive for the modern components.
ModernRecordingModal
Modern recording settings modal with glassmorphic design. Uses the same RecordingModalOptions as the original component.
ModernRequestsModal
Modern requests modal with glassmorphic design. Uses the same RequestsModalOptions as the original component.
ModernShareButtonOptions
Configuration options for a single share button in ModernShareButtonsComponent.
ModernShareButtonsComponent
A modern glassmorphic widget displaying social share buttons.
ModernShareButtonsComponentOptions
Configuration options for the ModernShareButtonsComponent widget.
ModernStandardPanelComponent
A modern standard recording configuration panel with glassmorphic styling.
ModernStandardPanelComponentOptions
Configuration options for ModernStandardPanelComponent. Uses the same StandardPanelComponentParameters as the original component.
ModernSwitch
A premium toggle switch with gradient fill when active.
ModernVideoCard
A modern video card with glassmorphic overlays, smooth animations, and an enhanced visual design. Uses the same VideoCardOptions as the original component.
ModernWaitingRoomModal
Modern waiting room modal with glassmorphic design. Uses the same WaitingRoomModalOptions as the original component.
ModernWelcomePage
Modern redesigned WelcomePage with glassmorphic styling. Retains all business logic from the original component.
NeumorphicButton
A neumorphic button with press feedback.
NeumorphicContainer
A neumorphic container with soft shadow effects creating a 3D raised appearance.
NeumorphicIconButton
A circular neumorphic icon button.
OtherGridComponent
Responsive container backing the MediaSFU "other participants" surface.
Pagination
A stateless widget rendering pagination controls with breakout room access management.
ParticipantsCounterBadge
ParticipantsCounterBadge - Displays the participants count with an icon and extensive customization hooks.
ParticipantsCounterBadgeOptions
ParticipantsCounterBadgeOptions - Configuration options for the ParticipantsCounterBadge widget.
ParticipantsModal
Modal dialog for viewing and managing session participants.
PollModal
Real-time polling interface enabling poll creation, voting, results, and history (role-based).
PreJoinPage
PreJoinPage
PremiumButton
A premium button component with modern styling and animations.
PremiumIconButton
A circular icon button with premium styling.
PremiumSearchField
A premium search field with animated clear button and search icon.
PremiumTextField
A premium text field with modern styling and animations.
PresetBackgrounds
Default preset backgrounds available in the SDK.
PulseBorderContainer
A container with an animated pulsing border effect.
PulseButton
An attention-grabbing pulsing button border.
PulseRing
A simple pulsing ring indicator.
RecordingModal
Server-side recording configuration modal with basic/advanced layout tabs.
RequestsModal
Requests modal displaying participant permission requests (screenshare/video/audio) with grant/deny actions (host-only).
Screenboard
Screenboard - Annotation overlay for screen sharing.
ScreenboardModal
ScreenboardModal - A modal component for managing screen annotation overlays.
ScreenboardModalOptions
Options for configuring the ScreenboardModal.
ScreenboardOptions
Options for the Screenboard widget. Matches React ScreenboardOptions interface.
SectionCard
A subtle card container used for grouped settings rows.
SectionTitle
A section title with a small gradient accent bar on the left.
SegmentationResult
Result of background segmentation processing.
ShareEventModal
Share-event modal displaying meeting ID, admin passcode, and social-sharing affordances.
ShimmerCard
Card-style shimmer skeleton for video grid placeholders.
ShimmerEffect
A shimmer animation effect for loading states.
ShimmerLoading
Shimmer loading placeholder used while data is loading.
SimpleAudioPlayer
A simple, invisible audio player widget for translation audio.
SkeletonCard
A skeleton card layout preset.
SkeletonListItem
A skeleton list item preset.
SkeletonLoader
A skeleton loading placeholder with shimmer animation.
SkeletonParagraph
A skeleton paragraph with multiple text lines.
SkeletonWrapper
A wrapper that shows skeleton or content based on loading state.
StaggeredAnimationList
A widget that animates its children with staggered delays.
StyledContainer
A versatile styled container that integrates all premium visual effects.
SubAspectComponent
A stateful widget rendering a responsive sub-video area with dynamic dimension management.
VirtualBackground
Virtual background configuration.
VirtualBackgroundProcessor
Platform-aware virtual background processor.
WaitingRoomModal
Waiting-room modal displaying queued participants with accept/reject actions (host-only).
WelcomePage
WelcomePage is a StatefulWidget that provides a welcome screen where users can enter details for an event, including event display name, token (secret), event ID, and event link. It includes options to validate input, handle socket connection, and provide feedback using alerts.
Whiteboard
Whiteboard - Real-time collaborative drawing and annotation canvas
WhiteboardOptions
Options for configuring the Whiteboard widget.
WhiteboardPainter
CustomPainter that renders all shapes on the whiteboard canvas.
WhiteboardShape
Represents a shape on the whiteboard.
WhiteboardToolbar
Toolbar widget for the whiteboard providing drawing tools and controls.

Enums

BackgroundType
Enum representing the type of virtual background.
GradientAnimationType
Types of gradient animations available.
LineType
Enum representing the different line types for shapes.
PremiumButtonSize
Size presets for PremiumButton.
PremiumButtonVariant
Style variants for PremiumButton.
PremiumTextFieldVariant
Style variants for PremiumTextField.
SidebarContent
Enum to track which content is displayed in the desktop sidebar
WhiteboardMode
Represents the current drawing mode of the whiteboard.
WhiteboardShapeType
Enum representing the different types of shapes that can be drawn on the whiteboard.

Extensions

MediasfuThemeExtension on BuildContext
Extension methods for easy theme access.

Properties

kHasHover bool
Whether this platform has a pointer that can hover.
final

Functions

modernAlertComponentBuilder({required AlertComponentOptions options}) Widget
Convenience builder conforming to AlertComponentType signature.
modernConfirmHereModalBuilder({required ConfirmHereModalOptions options}) Widget
Convenience builder conforming to ConfirmHereModalType signature.
modernLoadingModalBuilder({required LoadingModalOptions options}) Widget
Convenience builder conforming to LoadingModalType signature.
modernMainContainerComponentBuilder({required MainContainerComponentOptions options}) Widget
Convenience builder conforming to MainContainerComponentType signature.
modernMenuModalBuilder(MenuModalOptions options) Widget
Convenience builder conforming to MenuModalType signature.
modernPreJoinPageBuilder({PreJoinPageOptions? options}) Widget
Convenience builder conforming to PreJoinPageType signature.
modernWelcomePageBuilder({required WelcomePageOptions options}) Widget
Convenience builder conforming to WelcomePageType signature.

Typedefs

ModernAdvancedPanelType = Widget Function({required ModernAdvancedPanelComponentOptions options})
ModernAudioCardType = Widget Function({required AudioCardOptions options})
ModernAudioDecibelCheckType = Future<void> Function({required ModernAudioDecibelCheckOptions options})
ModernBackgroundModalType = Widget Function({required BackgroundModalOptions options})
ModernCardVideoDisplayContainerBuilder = Widget Function(ModernCardVideoDisplayContainerContext context)
ModernCardVideoDisplayType = Widget Function({required ModernCardVideoDisplayOptions options})
ModernCardVideoDisplayVideoBuilder = Widget Function(ModernCardVideoDisplayVideoContext context)
ModernCustomButtonsType = Widget Function(ModernCustomButtonsOptions options)
ModernDisplaySettingsModalType = Widget Function({required DisplaySettingsModalOptions options})
ModernEventSettingsModalType = Widget Function({required EventSettingsModalOptions options})
ModernFlexibleGridType = Widget Function({required FlexibleGridOptions options})
ModernMediaSettingsModalType = Widget Function({required MediaSettingsModalOptions options})
ModernMeetingIdComponentType = Widget Function({required ModernMeetingIdComponentOptions options})
ModernMeetingPasscodeComponentType = Widget Function(ModernMeetingPasscodeComponentOptions options)
ModernMeetingProgressTimerType = Widget Function({required MeetingProgressTimerOptions options})
ModernMessagePanelType = ModernMessagePanel Function(ModernMessagePanelOptions options)
ModernMessagesModalType = ModernMessagesModal Function({required MessagesModalOptions options})
ModernMiniAudioPlayerType = Widget Function(ModernMiniAudioPlayerOptions options)
ModernMiniCardType = Widget Function({required MiniCardOptions options})
ModernPaginationType = Widget Function({required PaginationOptions options})
ModernPanelistsModalType = Widget Function({required ModernPanelistsModalOptions options})
ModernParticipantListOthersType = Widget Function({required ModernParticipantListOthersOptions options})
ModernParticipantListType = Widget Function({required ModernParticipantListOptions options})
ModernParticipantsModalType = Widget Function({required ParticipantsModalOptions options})
ModernPermissionsModalType = Widget Function({required ModernPermissionsModalOptions options})
ModernPollModalType = ModernPollModal Function({required PollModalOptions options})
ModernRecordingModalType = Widget Function({required RecordingModalOptions options})
ModernRequestsModalType = Widget Function({required RequestsModalOptions options})
ModernShareButtonsComponentType = Widget Function(ModernShareButtonsComponentOptions options)
ModernStandardPanelType = Widget Function({required ModernStandardPanelComponentOptions options})
ModernVideoCardType = Widget Function({required VideoCardOptions options})
ModernWaitingRoomModalType = Widget Function({required WaitingRoomModalOptions options})