IvsVideoPlayer class

A Flutter widget for playing AWS IVS video streams.

This widget integrates with the AWS Interactive Video Service to provide live and on-demand video playback with customizable controls and overlays.

Parameters:

  • url: The stream URL to play
  • controller: Optional controller for programmatic control
  • autoPlay: Whether to start playback automatically (default: true)
  • showOverlayControls: Whether to show interactive overlay controls
  • loadingWidget: Custom loading widget (defaults to CircularProgressIndicator)
  • errorWidget: Custom error widget with built-in retry functionality
  • onError: Callback for error events

Example:

IvsVideoPlayer(
  url: 'https://stream-url.m3u8',
  autoPlay: true,
  showOverlayControls: true,
)
Inheritance

Constructors

IvsVideoPlayer({Key? key, required String url, IvsPlayerController? controller, bool autoPlay = true, bool showOverlayControls = false, Widget? loadingWidget, Widget? errorWidget, dynamic onError(String)?})
const

Properties

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

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<IvsVideoPlayer>
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