VideoControlsData class
Additional state passed to custom video controls and overlay builders.
Constructors
-
VideoControlsData({required dynamic player, required bool isFullscreen, bool isPictureInPicture = false, required bool areDefaultControlsVisible, required bool areControlsPinned, bool isBuffering = false, required EdgeInsets overlayPadding, required VoidCallback toggleFullscreen, required VoidCallback enterPictureInPicture, required VoidCallback restartVisibilityTimer, required VoidCallback showControls, required VoidCallback hideControls, required ValueChanged<
bool> setControlsPinned, required List<VideoQualityOption> availableQualities, required VideoQualityOption? currentQuality, required Future<void> selectQuality(VideoQualityOption quality), required Future<void> showQualitySelector(BuildContext context)}) -
const
Properties
- areControlsPinned → bool
-
Whether the built-in SDK controls are pinned open.
final
- areDefaultControlsVisible → bool
-
Whether the built-in SDK controls are currently visible.
final
-
availableQualities
→ List<
VideoQualityOption> -
Available quality options for the current video.
final
- currentQuality → VideoQualityOption?
-
Currently selected quality option, if known.
final
- enterPictureInPicture → VoidCallback
-
Enter Picture-in-Picture mode where supported.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideControls → VoidCallback
-
Hide the default controls and clear any active pin.
final
- isBuffering → bool
-
Whether playback is currently buffering or waiting for a live HLS segment.
final
- isFullscreen → bool
-
Whether the current video surface is in fullscreen mode.
final
- isPictureInPicture → bool
-
Whether the video surface is currently hosted in Android PiP.
final
- overlayPadding → EdgeInsets
-
Recommended safe padding for custom overlays to avoid the SDK chrome.
final
- player → dynamic
-
The underlying media_kit player instance.
final
- restartVisibilityTimer → VoidCallback
-
Show default controls and restart their visibility timer.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectQuality
→ Future<
void> Function(VideoQualityOption quality) -
Select a new quality option for playback.
final
-
setControlsPinned
→ ValueChanged<
bool> -
Pin or unpin the default controls.
final
- showControls → VoidCallback
-
Show the default controls.
final
-
showQualitySelector
→ Future<
void> Function(BuildContext context) -
Open the SDK's built-in quality selector UI.
final
- toggleFullscreen → VoidCallback
-
Toggle fullscreen for the current video surface.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited