universal/inner_headers library

Classes

AssetSource
Source representing the path of an application asset in your Flutter "assets" folder. Note that a prefix might be applied by your AudioPlayer's audio cache instance.
AudioCache
This class represents a cache for Local Assets to be played.
AudioContext
An Audio Context is a set of secondary, platform-specific aspects of audio playback, typically related to how the act of playing audio interacts with other features of the device. AudioContext is containing platform specific configurations: AudioContextAndroid and AudioContextIOS.
AudioContextAndroid
A platform-specific class to encapsulate a collection of attributes about an Android audio stream.
AudioContextConfig
This class contains flags to control several secondary, platform-specific aspects of audio playback, like how this audio interact with other audios, how is it played by the device and what happens when the app is backgrounded. However, note that each platform has its nuances on how to configure audio. This class is a generic abstraction of some parameters that can be useful across the board. Its flags are simple abstractions that are then translated to an AudioContext containing platform specific configurations: AudioContextAndroid and AudioContextIOS. If these simplified flags cannot fully reflect your goals, you must create an AudioContext configuring each platform separately.
AudioContextIOS
A platform-specific class to encapsulate a collection of attributes about an iOS audio stream.
AudioEvent
Event emitted from the platform implementation.
AudioLogger
AudioPlayer
This represents a single AudioPlayer, which can play one audio at a time. To play several audios at the same time, you must create several instances of this class.
AudioPool
An AudioPool is a provider of AudioPlayers that are pre-loaded with an asset to minimize delays.
AutoScrollController
AutoScrollTag
AutoScrollTagState<W extends AutoScrollTag>
BytesSource
Source containing the actual bytes of the media to be played.
Caption
A representation of a single caption.
ClosedCaption
Widget for displaying closed captions on top of a video.
ClosedCaptionFile
A structured representation of a parsed closed caption file.
DeviceFileSource
Source representing the absolute path of a file in the user's device.
DurationRange
Describes a discrete segment of time within a video using a start and end Duration.
FilePicker
The interface that implementations of file_picker must implement.
FilePickerResult
FlutterLocalization
FramePositionUpdater
GlobalAudioEvent
Event emitted from the platform implementation.
GlobalAudioScope
Handle global audio scope like calls and events concerning all AudioPlayers.
ImagePicker
Provides an easy way to pick an image/video from the image library, or to take a picture/video with the camera.
LostData
The response object of ImagePicker.retrieveLostData.
LostDataResponse
The response object of ImagePicker.getLostData.
MapLocale
PageAutoScrollController
PickedFile
A PickedFile is a cross-platform, simplified File abstraction.
PlatformFile
PositionUpdater
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.
SimpleAutoScrollController
Source
A generic representation of a source from where audio can be pulled.
SubRipCaptionFile
Represents a ClosedCaptionFile, parsed from the SubRip file format. See: https://en.wikipedia.org/wiki/SubRip
TimerPositionUpdater
UrlSource
Source representing a remote URL to be played from the Internet. This can be an audio file to be downloaded or an audio stream.
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.
VideoPlayerWebOptions
VideoPlayerWebOptions can be optionally used to set additional web settings
VideoPlayerWebOptionsControls
VideoPlayerWebOptions can be used to set how control options are displayed
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
VideoThumbnail
WebVTTCaptionFile
Represents a ClosedCaptionFile, parsed from the WebVTT file format. See: https://en.wikipedia.org/wiki/WebVTT
XFile
A CrossFile is a cross-platform, simplified File abstraction.

Enums

AndroidAudioFocus
There are four focus request types. A successful focus request with each will yield different behaviors by the system and the other application that previously held audio focus. See https://developer.android.com/reference/android/media/AudioFocusRequest
AndroidAudioMode
The audio mode encompasses audio routing AND the behavior of the telephony layer. Therefore this flag should only be used by applications that replace the platform-wide management of audio settings or the main telephony application. In particular, the inCall mode should only be used by the telephony application when it places a phone call, as it will cause signals from the radio layer to feed the platform mixer.
AndroidContentType
"what" you are playing. The content type expresses the general category of the content. This information is optional. But in case it is known (for instance movie for a movie streaming service or music for a music playback application) this information might be used by the audio framework to selectively configure some audio post-processing blocks.
AndroidUsageType
"why" you are playing a sound, what is this sound used for. This is achieved with the "usage" information. Examples of usage are media and alarm. These two examples are the closest to stream types, but more detailed use cases are available. Usage information is more expressive than a stream type, and allows certain platforms or routing policies to use this information for more refined volume or routing decisions. Usage is the most important information to supply in AudioContextAndroid and it is recommended to build any instance with this information supplied.
AudioContextConfigFocus
AudioContextConfigRoute
AudioEventType
AudioLogLevel
AutoScrollPosition
AVAudioSessionCategory
This is a Dart representation of the equivalent enum on Swift.
AVAudioSessionOptions
This is a Dart representation of the equivalent enum on Swift.
CameraDevice
Which camera to use when picking images/videos while source is ImageSource.camera.
DataSourceType
The way in which the video was originally loaded.
FilePickerStatus
FileType
GlobalAudioEventType
ImageFormat
Support most popular image formats. Uses libwebp to encode WebP image on iOS platform.
ImageSource
Specifies the source where the picked image should come from.
PlayerMode
This represents what kind of native implementation is used by the player.
PlayerState
Indicates the state of the audio player.
ReleaseMode
This enum is meant to be used as a parameter of setReleaseMode method.
RetrieveType
The type of the retrieved data in a LostDataResponse.
StorageDirectory
Corresponds to constants defined in Androids android.os.Environment class.
VideoFormat
The file format of the given video.

Constants

defaultDialogTitle → const String
defaultDurationUnit → const int
defaultScrollDistanceOffset → const double
kTypeImage → const String
Denotes that an image is being picked.
kTypeVideo → const String
Denotes that a video is being picked.
scrollAnimationDuration → const Duration

Properties

disablePathProviderPlatformOverride ← bool
no getter
enableLog ↔ bool
getter/setter pair

Functions

buildHighlightTransition({required BuildContext context, required Animation<double> highlight, required Widget child, Color? background, Color? highlightColor}) → Widget
chatPrint(String message) → void
chatPrintStack() → void
defaultViewportBoundaryGetter() → Rect
getApplicationCacheDirectory() → Future<Directory>
Path to a directory where the application may place application-specific cache files.
getApplicationDocumentsDirectory() → Future<Directory>
Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportDirectory() → Future<Directory>
Path to a directory where the application may place application support files.
getDownloadsDirectory() → Future<Directory?>
Path to the directory where downloaded files can be stored.
getExternalCacheDirectories() → Future<List<Directory>?>
Paths to directories where application specific cache data can be stored externally.
getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>
Paths to directories where application specific data can be stored externally.
getExternalStorageDirectory() → Future<Directory?>
Path to a directory where the application may access top level storage.
getLibraryDirectory() → Future<Directory>
Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getTemporaryDirectory() → Future<Directory>
Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.

Typedefs

AxisValueGetter = double Function(Rect rect)
StopFunction = Future<void> Function()
Represents a function that can stop an audio playing.
TagHighlightBuilder = Widget Function(BuildContext context, Animation<double> highlight)
TranslatorCallback = void Function(Locale?)
ViewportBoundaryGetter = Rect Function()

Exceptions / Errors

AudioPlayerException
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.