ScreenboardModal class

ScreenboardModal - A modal component for managing screen annotation overlays.

This component replicates React's ScreenboardModal approach:

  • On web: Combines screen video + annotation canvas into a single MediaStream
  • Uses HTML video/canvas elements for capture (web only)
  • Sends the combined stream via WebRTC to broadcast annotations

Key Features:

  • Annotation Broadcasting (Web): Combines screen share with annotations
  • Stream Management: Handles local screen stream and processed stream
  • Canvas Integration: Manages canvas for annotation rendering
  • Transport Lifecycle: Creates, connects, and disconnects WebRTC transport
  • Modal Controls: Close button with automatic cleanup

Example:

ScreenboardModal(
  options: ScreenboardModalOptions(
    parameters: screenboardParameters,
    isVisible: true,
    onClose: () => setState(() => isModalVisible = false),
  ),
)
Inheritance

Constructors

ScreenboardModal({Key? key, required ScreenboardModalOptions 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 ScreenboardModalOptions
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<ScreenboardModal>
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