QueueHandler mixin Null safety

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.

Superclass Constraints

Properties

playbackState BehaviorSubject<PlaybackState>
A controller for broadcasting the current PlaybackState to the app's UI, media notification and other clients. Example usage:
final, inherited
queue BehaviorSubject<List<MediaItem>>
A controller for broadcasting the current queue to the app's UI, media notification and other clients. Example usage:
final, inherited
queueTitle BehaviorSubject<String>
A controller for broadcasting the current queue title to the app's UI, media notification and other clients. Example usage:
final, inherited
mediaItem BehaviorSubject<MediaItem?>
A controller for broadcasting the current media item to the app's UI, media notification and other clients. Example usage:
final, inherited
androidPlaybackInfo BehaviorSubject<AndroidPlaybackInfo>
A controller for broadcasting the current AndroidPlaybackInfo to the app's UI, media notification and other clients. Example usage:
final, inherited
ratingStyle BehaviorSubject<RatingStyle>
A controller for broadcasting the current rating style to the app's UI, media notification and other clients. Example usage:
final, inherited
customEvent PublishSubject
A controller for broadcasting a custom event to the app's UI. A shorthand for the event stream is customEvent. Example usage:
final, inherited
customState BehaviorSubject
A controller for broadcasting the current custom state to the app's UI. Example usage:
final, inherited
hashCode int
The hash code for this object.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

addQueueItem(MediaItem mediaItem) Future<void>
Add mediaItem to the queue.
override
addQueueItems(List<MediaItem> mediaItems) Future<void>
Add mediaItems to the queue.
override
androidAdjustRemoteVolume(AndroidVolumeDirection direction) Future<void>
Adjust the remote volume on Android. This works only when using RemoteAndroidPlaybackInfo.
inherited
androidSetRemoteVolume(int volumeIndex) Future<void>
Set the remote volume on Android. This works only when using RemoteAndroidPlaybackInfo.
inherited
click([MediaButton button = MediaButton.media]) Future<void>
Process a headset button click, where button defaults to MediaButton.media.
inherited
customAction(String name, [Map<String, dynamic>? extras]) Future
A mechanism to support app-specific actions.
inherited
fastForward() Future<void>
Jump forward by AudioServiceConfig.fastForwardInterval.
inherited
getChildren(String parentMediaId, [Map<String, dynamic>? options]) Future<List<MediaItem>>
Get the children of a parent media item.
inherited
getMediaItem(String mediaId) Future<MediaItem?>
Get a particular media item.
inherited
insertQueueItem(int index, MediaItem mediaItem) Future<void>
Insert mediaItem into the queue at position index.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
onNotificationDeleted() Future<void>
Handle the notification being swiped away (Android).
inherited
onTaskRemoved() Future<void>
Handle the task being swiped away in the task manager (Android).
inherited
pause() Future<void>
Pause playback.
inherited
play() Future<void>
Start or resume playback.
inherited
playFromMediaId(String mediaId, [Map<String, dynamic>? extras]) Future<void>
Play a specific media item.
inherited
playFromSearch(String query, [Map<String, dynamic>? extras]) Future<void>
Begin playback from a search query.
inherited
playFromUri(Uri uri, [Map<String, dynamic>? extras]) Future<void>
Play a media item represented by a Uri.
inherited
playMediaItem(MediaItem mediaItem) Future<void>
Play a specific media item.
inherited
prepare() Future<void>
Prepare media items for playback.
inherited
prepareFromMediaId(String mediaId, [Map<String, dynamic>? extras]) Future<void>
Prepare a specific media item for playback.
inherited
prepareFromSearch(String query, [Map<String, dynamic>? extras]) Future<void>
Prepare playback from a search query.
inherited
prepareFromUri(Uri uri, [Map<String, dynamic>? extras]) Future<void>
Prepare a media item represented by a Uri for playback.
inherited
removeQueueItem(MediaItem mediaItem) Future<void>
Remove mediaItem from the queue.
override
removeQueueItemAt(int index) Future<void>
Remove media item from the queue at the specified index.
inherited
rewind() Future<void>
Jump backward by AudioServiceConfig.rewindInterval. Note: this value must be positive.
inherited
Search for media items.
inherited
seek(Duration position) Future<void>
Seek to position.
inherited
seekBackward(bool begin) Future<void>
Begin or end seeking backward continuously.
inherited
seekForward(bool begin) Future<void>
Begin or end seeking forward continuously.
inherited
setCaptioningEnabled(bool enabled) Future<void>
Set whether captioning is enabled.
inherited
setRating(Rating rating, [Map<String, dynamic>? extras]) Future<void>
Set the rating.
inherited
setRepeatMode(AudioServiceRepeatMode repeatMode) Future<void>
Set the repeat mode.
inherited
setShuffleMode(AudioServiceShuffleMode shuffleMode) Future<void>
Set the shuffle mode.
inherited
setSpeed(double speed) Future<void>
Set the playback speed.
inherited
skipToNext() Future<void>
Skip to the next item in the queue.
override
skipToPrevious() Future<void>
Skip to the previous item in the queue.
override
skipToQueueItem(int index) Future<void>
This should be overridden to skip to the queue item at index. Implementations should broadcast the new queue index via playbackState, broadcast the new media item via mediaItem, and potentially issue instructions to start the new item playing. Some implementations may choose to automatically play when skipping to a queue item while others may prefer to play the new item only if the player was already playing another item beforehand.
override
stop() Future<void>
Stop playback and release resources.
inherited
subscribeToChildren(String parentMediaId) ValueStream<Map<String, dynamic>>
Get a value stream that emits service-specific options to send to the client whenever the children under the specified parent change. The emitted options may contain information about what changed. A client that is subscribed to this stream should call getChildren to obtain the changed children.
inherited
toString() String
A string representation of this object.
inherited
updateMediaItem(MediaItem mediaItem) Future<void>
Update the properties of mediaItem.
override
updateQueue(List<MediaItem> newQueue) Future<void>
Update to the queue to queue.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited