IsolatedAudioHandler class

A CompositeAudioHandler that can be accessed from other isolates via lookup.

This handler recognises the custom action 'unregister' so that customAction('unregister') can be called from a client to unregister this handler, or it can be unregistered by a direct invocation of unregister.

Inheritance

Constructors

IsolatedAudioHandler(AudioHandler inner, {String portName = defaultPortName, bool overridePortName = false})
Creates an IsolatedAudioHandler that can be looked up by portName (defaulting to defaultPortName).

Properties

androidPlaybackInfo → ValueStream<AndroidPlaybackInfo>
A value stream of the current AndroidPlaybackInfo.
no setterinherited
customEvent Stream
A stream of custom events.
no setterinherited
customState → ValueStream
A stream of custom states.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
mediaItem → ValueStream<MediaItem?>
A value stream of the current media item.
no setterinherited
playbackState → ValueStream<PlaybackState>
A value stream of playback states.
no setterinherited
portName String
The port name to use when looking up this handler.
final
queue → ValueStream<List<MediaItem>>
A value stream of the current queue.
no setterinherited
queueTitle → ValueStream<String>
A value stream of the current queueTitle.
no setterinherited
ratingStyle → ValueStream<RatingStyle>
A value stream of the current rating style.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addQueueItem(MediaItem mediaItem) Future<void>
Add mediaItem to the queue.
inherited
addQueueItems(List<MediaItem> mediaItems) Future<void>
Add mediaItems to the queue.
inherited
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.
override
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent 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.
inherited
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.
inherited
skipToPrevious() Future<void>
Skip to the previous item in the queue.
inherited
skipToQueueItem(int index) Future<void>
Skip to a queue item.
inherited
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
unregister() → void
Unregisters this handler so that it can no longer be looked up by portName.
updateMediaItem(MediaItem mediaItem) Future<void>
Update the properties of mediaItem.
inherited
updateQueue(List<MediaItem> queue) Future<void>
Update to the queue to queue.
inherited

Operators

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

Static Methods

lookup({String portName = defaultPortName}) Future<AudioHandler>
Connect to an IsolatedAudioHandler from another isolate having the name portName (defaulting to defaultPortName).

Constants

defaultPortName → const String
The default port name by which this isolated audio handler can be looked up.