ControlsOverlay class

A state-responsive overlay widget that displays appropriate UI elements based on the current AWS IVS player state.

This widget automatically switches between:

  • Loading indicators during loading state
  • Error messages with retry functionality during error state
  • Interactive playback controls for playing, paused, idle, stopped, and ready states
  • Empty widget when disposed

Parameters:

  • controller: Manages player state and operations
  • url: Stream URL used for retry operations
  • loadingWidget: Optional custom loading widget (defaults to CircularProgressIndicator)
  • errorWidget: Optional custom error widget (defaults to PlayerErrorWidget)
  • isDisposed: Prevents rendering when parent widget is disposed

Example:

ControlsOverlay(
  controller: myController,
  url: 'https://stream-url.m3u8',
  loadingWidget: CustomSpinner(),
  errorWidget: CustomErrorDisplay(),
  isDisposed: false,
)
Inheritance

Constructors

ControlsOverlay({Key? key, required IvsPlayerController? controller, required String url, required Widget? loadingWidget, required Widget? errorWidget, required bool isDisposed})
const

Properties

controller → IvsPlayerController?
final
errorWidget → Widget?
final
hashCode → int
The hash code for this object.
no setterinherited
isDisposed → bool
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingWidget → Widget?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
url → String
final

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