VideoControlsConfig class
Configuration class for video controls.
This class holds various settings and customizations for video controls.
Constructors
-
VideoControlsConfig({bool enablePlayPause = true, bool enableProgressBar = true, bool enableProgressText = true, Color? progressBarColor, IconData? playIcon = Icons.play_circle_filled, IconData? pauseIcon = Icons.pause_circle_filled, Color? playPauseIconColor, bool enableSeekPreview = false, double previewWidth = 144.0, double previewHeight = 86.0, Offset previewOffset = const Offset(0, -20), BoxDecoration? previewDecoration, Widget previewBuilder(Duration position, Widget previewFrame)?, Widget playPauseBuilder(dynamic player, VoidCallback onTap)?, Widget progressBarBuilder(dynamic player, Duration current, Duration total)?, VideoCustomControlsBuilder? customControlsBuilder, VideoOverlayBuilder? overlayBuilder, SeekPreviewPerformanceOptions performanceOptions = const SeekPreviewPerformanceOptions(), bool showLiveMuteControl = true, bool useDefaultControls = true, List<
SubtitleSource> ? subtitles, List<VideoResolution> ? resolutions}) -
const
Properties
- customControlsBuilder → VideoCustomControlsBuilder?
-
A builder for fully custom video controls.
final
- enablePlayPause → bool
-
Whether to enable the play/pause button.
final
- enableProgressBar → bool
-
Whether to enable the progress bar.
final
- enableProgressText → bool
-
Whether to enable the progress text.
final
- enableSeekPreview → bool
-
Whether to enable seek preview.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- overlayBuilder → VideoCustomControlsBuilder?
-
A builder for additional UI layered on top of the video.
final
- pauseIcon → IconData?
-
The icon to use for the pause button.
final
- performanceOptions → SeekPreviewPerformanceOptions
-
Performance options for seek preview
final
- playIcon → IconData?
-
The icon to use for the play button.
final
- playPauseBuilder → Widget Function(dynamic player, VoidCallback onTap)?
-
A builder function for the play/pause button.
final
- playPauseIconColor → Color?
-
The color of the play/pause icons.
final
- previewBuilder → Widget Function(Duration position, Widget previewFrame)?
-
A builder function for the seek preview.
final
- previewDecoration → BoxDecoration?
-
The decoration of the seek preview.
final
- previewHeight → double
-
The height of the seek preview.
final
- previewOffset → Offset
-
The offset of the seek preview.
final
- previewWidth → double
-
The width of the seek preview.
final
- progressBarBuilder → Widget Function(dynamic player, Duration current, Duration total)?
-
A builder function for the progress bar.
final
- progressBarColor → Color?
-
The color of the progress bar.
final
-
resolutions
→ List<
VideoResolution> ? -
List of available video resolutions
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showLiveMuteControl → bool
-
Whether to show the mute/unmute button in live video controls.
final
-
subtitles
→ List<
SubtitleSource> ? -
List of subtitle files to be loaded
final
- useDefaultControls → bool
-
Whether to use the built-in default controls
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