enough_media library

An opinionated but extensible collection of media widgets

Classes

AssetMediaProvider
Provides assets as media
AudioInteractiveMedia
Displays simple audio player
Caption
A representation of a single caption.
Chewie
A Video Player with Material and Cupertino skins.
ChewieController
The ChewieController is used to configure and drive the Chewie Player Widgets. It provides methods to control playback, such as pause and play, as well as methods that control the visual appearance of the player, such as enterFullScreen or exitFullScreen.
ChewieControllerProvider
ChewieProgressColors
ChewieState
ClosedCaption
Widget for displaying closed captions on top of a video.
ClosedCaptionFile
A structured representation of a parsed closed caption file.
CupertinoControls
DurationRange
Describes a discrete segment of time within a video using a start and end Duration.
FlutterSoundCompletedFFmpegExecution
Represents a completed FFmpeg execution.
FlutterSoundFFmpeg
FlutterSoundFFmpegConfig
FlutterSoundFFmpegExecution
Represents an ongoing FFmpeg execution.
FlutterSoundFFprobe
FlutterSoundHelper
FlutterSoundHelper class is for handleing audio files and buffers. Most of those utilities use FFmpeg, so are not available in the LITE flavor of Flutter Sound.
FlutterSoundLog
FlutterSoundMediaInformation
FlutterSoundPlayer
A Player is an object that can playback from various sources.
FlutterSoundRecorder
A Recorder is an object that can playback from various sources.
FlutterSoundStatistics
FlutterSoundStreamInformation
Food
Food is an abstract class which represents objects that can be sent to a player when playing data from astream or received by a recorder when recording to a Dart Stream.
FoodData
FoodData are the regular objects received from a recorder when recording to a Dart Stream or sent to a player when playing from a Dart Stream
FoodEvent
foodEvent is a special kin of food which allows to re-synchronize a stream with a player that play from a Dart Stream
ImageInteractiveMedia
Displays zoomable images
ImagePreview
InteractiveMediaWidget
MaterialControls
MaterialDesktopControls
MediaProvider
MemoryMediaProvider
Provides preloaded media
OptionItem
OptionsTranslation
PdfController
Pages control
PdfDocument
PDF page image renderer
PdfInteractiveMedia
Displays PDFs
PdfPage
An integral part of a document is its page, which contains a method render for rendering into an image
PdfPageFormat
Image compression format
PdfPageImage
Object containing a rendered image in a pre-selected format in _render method of PdfPage
PdfPageImageProvider
PdfView
Widget for viewing PDF documents
PhotoView
A StatefulWidget that contains all the photo view rendering elements.
PhotoViewComputedScale
A class that work as a enum. It overloads the operator * saving the double as a multiplier.
PhotoViewController
The default implementation of PhotoViewControllerBase.
PhotoViewControllerBase<T extends PhotoViewControllerValue>
The interface in which controllers will be implemented.
PhotoViewControllerValue
The state value stored and streamed by PhotoViewController.
PhotoViewGallery
A StatefulWidget that shows multiple PhotoView widgets in a PageView
PhotoViewGalleryPageOptions
A helper class that wraps individual options of a page in PhotoViewGallery
PhotoViewGestureDetectorScope
An InheritedWidget responsible to give a axis aware scope to PhotoViewGestureRecognizer.
PhotoViewHeroAttributes
Data class that holds the attributes that are going to be passed to PhotoViewImageWrapper's Hero.
PhotoViewScaleStateController
A controller responsible only by scaleState.
PlaybackDisposition
Used to stream data about the position of the playback as playback proceeds.
PlaybarSlider
PreviewMediaWidget
Shows the provided media in a preview mode.
RecordedAudio
RecordedAudio is used to track the audio media created during a recording session via the SoundRecorderUI.
RecorderPlaybackController
This class is a Provider style widget designed to co-ordinate a SoundRecorderUI and a SoundPlayerUI so that a user can record and playback in a co-ordinated manner.
RecordingDisposition
Holds point in time details of the recording disposition including the current duration and decibels.
SoundPlayerUI
SoundRecorderUI
A UI for recording audio.
SoundRecorderUIState
SubRipCaptionFile
Represents a ClosedCaptionFile, parsed from the SubRip file format. See: https://en.wikipedia.org/wiki/SubRip
Subtitle
Subtitles
TextMediaProvider
Track
The track to play by FlutterSoundPlayer.startPlayerFromTrack().
UrlMediaProvider
Media provider for remote media files
VideoInteractiveMedia
VideoPlayer
Widget that displays the video controlled by controller.
VideoPlayerController
Controls a platform video player, and provides updates when the state is changing.
VideoPlayerOptions
VideoPlayerOptions can be optionally used to set additional player settings
VideoPlayerValue
The duration, current position, buffering state, error state and settings of a VideoPlayerController.
VideoProgressColors
Used to configure the VideoProgressIndicator widget's colors for how it describes the video's status.
VideoProgressIndicator
Displays the play/buffering status of the video controlled by controller.
VideoScrubber
A scrubber to control VideoPlayerControllers
WebVTTCaptionFile
Represents a ClosedCaptionFile, parsed from the WebVTT file format. See: https://en.wikipedia.org/wiki/WebVTT
WidgetRegistry

Enums

AndroidFocusGain
AudioDevice
AudioFocus
Control the focus mode.
Codec
DataSourceType
The way in which the video was originally loaded.
PhotoViewScaleState
A way to represent the step of the "doubletap gesture cycle" in which PhotoView is.
PlayerState
The possible states of the Player.
SessionCategory
SessionMode
VideoFormat
The file format of the given video.

Constants

allowAirPlay → const int
allowBlueTooth → const int
allowBlueToothA2DP → const int
allowEarPiece → const int
allowHeadset → const int
ext → const List<String>
The usual file extensions used for each codecs
iosAllowAirplay → const int
iosAllowBluetooth → const int
iosAllowBluetoothA2DP → const int
iosDefaultToSpeaker → const int
iosDuckOthers → const int
iosInterruptSpokenAudioAndMixWithOthers → const int
iosMixWithOthers → const int
outputToSpeaker → const int
validExt → const List<List<String>>
The valid file extensions for each codecs

Properties

flutterSoundHelper ↔ FlutterSoundHelper
The FlutterSoundHelper singleton for accessing the helpers functions
getter/setter pair

Functions

connectPlayerToRecorderStream(SoundPlayerUIState playerState, Stream<PlaybackDisposition>? recorderStream) → void
Functions used to hide internal implementation details
defaultScaleStateCycle(PhotoViewScaleState actual) → PhotoViewScaleState
The default ScaleStateCycle
hasPdfSupport() → Future<bool>
onPlaybackEnd(BuildContext context) → void
onPlaybackStart(BuildContext context) → void
onRecordingNew(BuildContext context, SoundRecorderUIState recorder) → void
onRecordingPaused(BuildContext context) → void
onRecordingResume(BuildContext context) → void
onRecordingStopped(BuildContext context, Duration duration) → void
registerPlayer(BuildContext context, SoundPlayerUIState player) → void
registerRecorder(BuildContext context, SoundRecorderUIState recorder) → void

Typedefs

ChewieRoutePageBuilder = Widget Function(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, ChewieControllerProvider controllerProvider)
ExecuteCallback = void Function(FlutterSoundCompletedFFmpegExecution execution)
LoadingBuilder = Widget Function(BuildContext context, ImageChunkEvent? event)
A type definition for a callback to show a widget while the image is loading, a ImageChunkEvent is passed to inform progress
OnDelete = void Function()
Callback fn type
OnLoad = Future<Track> Function(BuildContext context)
OnPaused = void Function(RecordedAudio media, bool isPaused)
Callback fn type
OnProgress = void Function(RecordedAudio media)
Callback fn type
OnStart = void Function()
Callback fn type
OnStop = void Function(RecordedAudio media)
Callback fn type
PDFViewPageBuilder = PhotoViewGalleryPageOptions Function(Future<PdfPageImage> pageImage, int index, PdfDocument document)
PDFViewPageRenderer = Future<PdfPageImage?> Function(PdfPage page)
PhotoViewGalleryBuilder = PhotoViewGalleryPageOptions Function(BuildContext context, int index)
A type definition for a Function that defines a page in PhotoViewGallery.build
PhotoViewGalleryPageChangedCallback = void Function(int index)
A type definition for a Function that receives a index after a page change in PhotoViewGallery
PhotoViewImageScaleEndCallback = dynamic Function(BuildContext context, ScaleEndDetails details, PhotoViewControllerValue controllerValue)
A type definition for a callback when a user finished scale
PhotoViewImageTapDownCallback = dynamic Function(BuildContext context, TapDownDetails details, PhotoViewControllerValue controllerValue)
A type definition for a callback when the user taps down the photoview region
PhotoViewImageTapUpCallback = dynamic Function(BuildContext context, TapUpDetails details, PhotoViewControllerValue controllerValue)
A type definition for a callback when the user taps up the photoview region
ScaleStateCycle = PhotoViewScaleState Function(PhotoViewScaleState actual)
A type definition for a Function that receives the actual PhotoViewScaleState and returns the next one It is used internally to walk in the "doubletap gesture cycle". It is passed to PhotoView.scaleStateCycle
ScaleStateListener = void Function(double prevScale, double nextScale)
StatisticsCallback = void Function(FlutterSoundStatistics? statistics)
TonPaused = void Function(bool paused)
Playback function type for FlutterSoundPlayer.startPlayerFromTrack().
TonSkip = void Function()
Playback function type for FlutterSoundPlayer.startPlayerFromTrack().
TWhenFinished = void Function()
Playback function type for FlutterSoundPlayer.startPlayer().
UIRequestPermission = Future<bool> Function(BuildContext context, Track track)
The requestPermissions callback allows you to provide an UI informing the user that we are about to ask for a permission.