LivestreamPlayer class
Creates a widget that allows a user to view a livestream.
By default, the widget has call controls and other elements including: play/pause the stream, live/backstage indicator, participant count, call duration, mute/unmute call, expand/contract livestream.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- LivestreamPlayer
Constructors
-
LivestreamPlayer.new({Key? key, required Call call, bool showParticipantCount = true, WidgetBuilder? backButtonBuilder, LivestreamEndedBuilder? livestreamEndedBuilder, LivestreamBackstageBuilder? livestreamBackstageBuilder, LivestreamControlsBuilder? livestreamControlsBuilder, VideoPlaceholderBuilder? videoPlaceholderBuilder, VideoRendererBuilder? videoRendererBuilder, LivestreamNotConnectedBuilder? livestreamNotConnectedBuilder, bool allowDiagnostics = false, void onCallDisconnected(CallDisconnectedProperties)?, FutureOr<
void> onRecordingTapped(String)?, VoidCallback? onFullscreenTapped, bool startInFullscreenMode = false}) -
Creates a livestream player
const
Properties
- allowDiagnostics → bool
-
Boolean to allow a user to double-tap a call to see diagnostic data.
final
- backButtonBuilder → WidgetBuilder?
-
WidgetBuilder used to build an action button on the top left side of
the screen.
final
- call → Call
-
The livestream call to display.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- livestreamBackstageBuilder → LivestreamBackstageBuilder?
-
The builder used to create a custom widget when the livestream is in backstage mode.
final
- livestreamControlsBuilder → LivestreamControlsBuilder?
-
The builder used to create custom controls for the livestream player.
This allows customization of the control UI elements displayed during the livestream.
final
- livestreamEndedBuilder → LivestreamEndedBuilder?
-
The builder used to create a custom widget when the livestream has ended.
final
-
Builder function used to create a custom widget when a livestream is connected
but no hosts have video enabled.
final
- livestreamNotConnectedBuilder → LivestreamNotConnectedBuilder?
-
Builder function used to create a custom widget when the livestream is not connected.
Provides connection state information (isMigrating, isReconnecting) that can be
used to show appropriate status messages.
final
- onCallDisconnected → void Function(CallDisconnectedProperties)?
-
The action to perform when the call is disconnected. By default, it pops the current route.
final
- onFullscreenTapped → VoidCallback?
-
The action to perform when dfullscreen button is tapped.
final
-
onRecordingTapped
→ FutureOr<
void> Function(String)? -
The action to perform when the recording shown when livestream is ended is tapped.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showParticipantCount → bool
-
Boolean to display participant count.
final
- startInFullscreenMode → bool
-
Determines whether the livestream should start in fullscreen mode.
When true, the video will expand to cover the entire available space.
When false, the video will be contained within its boundaries.
Defaults to false.
final
- videoPlaceholderBuilder → VideoPlaceholderBuilder?
-
Builder function used to build a video placeholder.
final
- videoRendererBuilder → VideoRendererBuilder?
-
Builder function used to build a video renderer.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< LivestreamPlayer> -
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