components library
Classes
- AlertComponent
- Full-screen alert overlay displaying success/error messages with auto-dismiss and tap-to-dismiss.
- 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.
- BackgroundModal
- BackgroundModal - Modal for selecting virtual backgrounds.
- BackgroundModalOptions
- Options for the BackgroundModal widget.
- 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 forConfirmExitModal. - 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 theDisplaySettingsModal. - EventSettingsModal
-
EventSettingsModalOptions- Configuration options forEventSettingsModal. - FlexibleGrid
- A responsive grid widget built specifically for the MediaSFU UI surface.
- FlexibleVideo
- Responsive video-grid widget that powers MediaSFU's main participant layout.
- 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 theMediaSettingsModal. - MediasfuBroadcast
-
MediasfuBroadcast- A generic widget for initializing and managing Mediasfu functionalities. - MediasfuChat
-
MediasfuChat- A generic widget for initializing and managing Mediasfu functionalities. - MediasfuConference
-
MediasfuConference- A generic widget for initializing and managing Mediasfu functionalities. - MediasfuGeneric
-
MediasfuGeneric- A generic widget for initializing and managing Mediasfu functionalities. - MediasfuWebinar
-
MediasfuWebinar- A generic widget for initializing and managing Mediasfu functionalities. - MeetingProgressTimer
-
MeetingProgressTimer- Displays the meeting progress time with extensive customization hooks. - MenuModal
-
MenuModalOptions- Configuration options for theMenuModalwidget. - 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.
- 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
ParticipantsCounterBadgewidget. - 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
- PresetBackgrounds
- Default preset backgrounds available in the SDK.
- 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.
- SegmentationResult
- Result of background segmentation processing.
- Share-event modal displaying meeting ID, admin passcode, and social-sharing affordances.
- SimpleAudioPlayer
- A simple, invisible audio player widget for translation audio.
- 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
-
WelcomePageis 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.
- LineType
- Enum representing the different line types for shapes.
- WhiteboardMode
- Represents the current drawing mode of the whiteboard.
- WhiteboardShapeType
- Enum representing the different types of shapes that can be drawn on the whiteboard.