CustomVideoPlayerSettings class
Constructors
-
CustomVideoPlayerSettings({bool showMuteButton = true, bool? allowVolumeOnSlide = true, double? customAspectRatio, Widget? placeholderWidget, Widget? thumbnailWidget, Duration seekDuration = const Duration(seconds: 10), bool showSeekButtons = false, bool alwaysShowThumbnailOnVideoPaused = false, EdgeInsets controlsPadding = const EdgeInsets.all(5), EdgeInsets controlBarPadding = const EdgeInsets.all(5), Widget playButton = const CustomVideoPlayerPlayButton(), Widget pauseButton = const CustomVideoPlayerPauseButton(), Widget settingsButton = const CustomVideoPlayerSettingsButton(), Widget enterFullscreenButton = const CustomVideoPlayerEnterFullscreenButton(), Widget exitFullscreenButton = const CustomVideoPlayerExitFullscreenButton(), BoxDecoration controlBarDecoration = const BoxDecoration(color: Color.fromRGBO(0, 0, 0, 0.5), borderRadius: BorderRadius.all(Radius.circular(10))), TextStyle durationPlayedTextStyle = const TextStyle(color: Colors.white, fontSize: 14, fontFeatures: [FontFeature.tabularFigures()]), TextStyle durationRemainingTextStyle = const TextStyle(color: Colors.white, fontSize: 14, fontFeatures: [FontFeature.tabularFigures()]), CustomVideoPlayerProgressBarSettings customVideoPlayerProgressBarSettings = const CustomVideoPlayerProgressBarSettings(), bool showDurationPlayed = true, bool showDurationRemaining = true, bool controlBarAvailable = true, bool enterFullscreenOnStart = false, bool exitFullscreenOnEnd = false, bool showPlayButton = true, bool playOnlyOnce = false, bool autoFadeOutControls = true, Duration durationAfterControlsFadeOut = const Duration(seconds: 3), bool showFullscreenButton = !kIsWeb, SystemUiMode systemUIModeAfterFullscreen = SystemUiMode.edgeToEdge, SystemUiMode systemUIModeInsideFullscreen = SystemUiMode.leanBack, List<
SystemUiOverlay> systemUIOverlaysAfterFullscreen = SystemUiOverlay.values, List<DeviceOrientation> deviceOrientationsAfterFullscreen = DeviceOrientation.values, bool settingsButtonAvailable = true, bool playbackSpeedButtonAvailable = true, TextStyle playbackButtonTextStyle = const TextStyle(color: Colors.white, fontSize: 14, fontFeatures: [FontFeature.tabularFigures()]), CustomVideoPlayerPopupSettings customVideoPlayerPopupSettings = const CustomVideoPlayerPopupSettings()}) -
const
Properties
- allowVolumeOnSlide → bool?
-
Allow volume change on sliding right part of screen
final
- alwaysShowThumbnailOnVideoPaused → bool
-
When this is true, the thumbnail will always be shown when the video is paused.
If set to false, the thumbnail will only be shown when the video is at the beginning.
final
- autoFadeOutControls → bool
-
If set the video controls will be faded out after the durationAfterControlsFadeOut has passed.
final
- controlBarAvailable → bool
-
Set to false if no control bar should be available.
final
- controlBarDecoration → BoxDecoration
-
The appearance of the control bar.
final
- controlBarPadding → EdgeInsets
-
The padding of the control bar from the edges to its contents.
final
- controlsPadding → EdgeInsets
-
The padding between the controls and the edges of the video player
final
- customAspectRatio → double?
-
Define a custom aspect ratio for the video.
final
- customVideoPlayerPopupSettings → CustomVideoPlayerPopupSettings
-
UI settings for the video settings popup.
final
- customVideoPlayerProgressBarSettings → CustomVideoPlayerProgressBarSettings
-
The settings for the progress bar in the middle of the control bar.
final
-
deviceOrientationsAfterFullscreen
→ List<
DeviceOrientation> -
The possible device orientations after leaving fullscreen. For example if the app was a portrait only app before then set the orientations to DeviceOrientation.portraitUp here again.
final
- durationAfterControlsFadeOut → Duration
-
The duration after which the controls will fade out. Recommended duration is >= 2 seconds.
final
- durationPlayedTextStyle → TextStyle
-
The TextStyle of the played duration left from the progress bar.
final
- durationRemainingTextStyle → TextStyle
-
The TextStyle of the remaining duration right from the progress bar.
final
- enterFullscreenButton → Widget
-
Define the enter-fullscreen button appearance.
final
- enterFullscreenOnStart → bool
-
If set the video will enter the fullscreen mode on start.
final
- exitFullscreenButton → Widget
-
Define the exit-fullscreen button appearance.
final
- exitFullscreenOnEnd → bool
-
If set the video will leave the fullscreen mode when its finished. Nothing happens if video wasn't in fullscreen before.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- pauseButton → Widget
-
Define the pause button appearance.
final
- placeholderWidget → Widget?
-
The widget that should be shown as long the video is not initialized.
final
- playbackButtonTextStyle → TextStyle
-
TextStyle for the playback speed.
final
- playbackSpeedButtonAvailable → bool
-
Set to false if no playback speed adjustment button should be shown.
final
- playButton → Widget
-
Define the play button appearance.
final
- playOnlyOnce → bool
-
If set the video can only be played once.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- seekDuration → Duration
-
Define a custom aspect ratio for the video.
final
- settingsButton → Widget
-
Define the settings button appearance.
final
- settingsButtonAvailable → bool
-
If the settings button should be shown or not.
final
- showDurationPlayed → bool
-
If set to false the duration played will not be displayed.
final
- showDurationRemaining → bool
-
If set to false the duration remaining will not be displayed.
final
- showFullscreenButton → bool
-
If set to false no enter/exit fullscrenn button will not be displayed. Default it wont be displayed in web because there fullscreen doesnt work properly
final
- showMuteButton → bool
-
Show or hide mute button
final
- showPlayButton → bool
-
If set to false no play/pause button will not be displayed.
final
- showSeekButtons → bool
-
show seek buttons
final
- systemUIModeAfterFullscreen → SystemUiMode
-
The SystemUiMode after leaving the fullscreen mode. Defaults to SystemUiMode.edgeToEdge.
final
- systemUIModeInsideFullscreen → SystemUiMode
-
The SystemUiMode when entering the fullscreen mode. Defaults to SystemUiMode.leanBack.
final
-
systemUIOverlaysAfterFullscreen
→ List<
SystemUiOverlay> -
The system ui overlays after fullscreen mode. Especially useful if systemUIModeAfterFullscreen is set to SystemUiMode.manual.
final
- thumbnailWidget → Widget?
-
The thumbnail widget of the video. Mostly that will be an image widget
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