audio_service library

Classes

AndroidContentStyle
Key/value codes for use in MediaItem.extras and AudioServiceConfig.androidBrowsableRootExtras to influence how Android Auto will style browsable and playable media items.
AndroidPlaybackInfo
Information about volume control for either local or remote playback depending on the subclass.
AndroidVolumeDirection
An enum of volume direction controls on Android.
AudioHandler
An AudioHandler plays audio, provides state updates and query results to clients. It implements standard protocols that allow it to be remotely controlled by the lock screen, media notifications, the iOS control center, headsets, smart watches, car audio systems, and other compatible agents.
AudioService
Provides an API to manage the app's AudioHandler. An app must call init during initialisation to register the AudioHandler that will service all requests to play audio.
AudioServiceBackground
This class is deprecated. Use the stream subjects in BaseAudioHandler instead.
AudioServiceConfig
The configuration options to use when intializing the AudioService.
AudioServiceWidget
This widget is no longer required and has been deprecated.
BackgroundAudioTask
This class is deprecated. Use BaseAudioHandler instead.
BaseAudioHandler
Base class for implementations of AudioHandler. It provides default implementations of all methods and streams. Each stream in this class is specialized as either a BehaviorSubject or PublishSubject providing an additional add method for emitting values on those streams.
CompositeAudioHandler
A CompositeAudioHandler wraps another AudioHandler and adds additional behaviour to it. Each method will by default pass through to the corresponding method of the wrapped handler. If you override a method, it must call super in addition to any "additional" functionality you add.
CustomMediaAction
Custom action information used to define an action name and optional extras that are sent to AudioHandler.customAction when the associated media control is used.
IsolatedAudioHandler
A CompositeAudioHandler that can be accessed from other isolates via lookup.
LocalAndroidPlaybackInfo
Playback information for local volume handling.
MediaControl
A button to appear in the Android notification, lock screen, Android smart watch, or Android Auto device. The set of buttons you would like to display at any given moment should be streamed via AudioHandler.playbackState.
MediaItem
Metadata of an audio item that can be played, or a folder containing audio items.
MediaItemCopyWith
The copyWith function type for MediaItem.
PlaybackState
The playback state which includes a playing boolean state, a processing state such as AudioProcessingState.buffering, the playback position and the currently enabled actions to be shown in the Android notification or the iOS control center.
PlaybackStateCopyWith
The copyWith function type for PlaybackState.
Rating
A rating to attach to a MediaItem.
RemoteAndroidPlaybackInfo
Playback information for remote volume handling.
SwitchAudioHandler
A SwitchAudioHandler wraps another AudioHandler that may be switched for another at any time by setting inner.

Mixins

QueueHandler
This mixin provides default implementations of methods for updating and navigating the queue. When using this mixin, you must add a list of MediaItems to queue, override skipToQueueItem and initialise the queue index (e.g. by calling skipToQueueItem with the initial queue index). The skipToNext and skipToPrevious default implementations are defined by this mixin in terms of your own implementation of skipToQueueItem.
SeekHandler
This mixin provides default implementations of fastForward, rewind, seekForward and seekBackward which are all defined in terms of your own implementation of seek.

Extensions

AudioServiceValueStream
(Maybe) temporary.

Enums

AndroidVolumeControlType
An enumeration of different volume control types on Android.
AudioProcessingState
The states of audio processing.
AudioServiceRepeatMode
The available repeat modes.
AudioServiceShuffleMode
The available shuffle modes for the queue.
MediaAction
The actions associated with playing audio.
MediaButton
The buttons on a headset.
RatingStyle
The style of a Rating.