MediaManager

public classMediaManagerextendsObject

Manager class for all media status and commands.

This class is responsible to translate media namespace messages from senders into media commands, and send media status back to the sender.

Nested Class Summary

interface MediaManager.MediaStatusInterceptor Interceptor interface for MediaStatus.

Public Method Summary

void	broadcastMediaStatus() Trigger a media status broadcast.
MediaStatus	getBaseMediaStatus() Returns the base`MediaStatus` which is generated from Android MediaSession, before applying any overrides from`MediaStatusModifier`,`MediaQueueManager`or`MediaManager.MediaStatusInterceptor`.
MediaStatus	getCurrentMediaStatus() Returns the current`MediaStatus` generated from the base`MediaStatus` with overrides applied from`MediaStatusModifier`and`MediaQueueManager`(note that changes from`MediaManager.MediaStatusInterceptor`is not applied).
MediaQueueManager	getMediaQueueManager() Returns the`MediaQueueManager`.
MediaStatusModifier	getMediaStatusModifier() Returns the`MediaStatusModifier`.
boolean	onNewIntent(Intent intent) Passes a new activity intent to`MediaManager`.
void	setDataFromLoad(MediaLoadRequestData loadRequestData) Initializes`MediaStatusModifier`and`MediaQueueManager`overrides using the information from a load request.
void	setMediaCommandCallback(MediaCommandCallback callback) Sets the`MediaCommandCallback`.
void	setMediaLoadCommandCallback(MediaLoadCommandCallback callback) Sets the`MediaLoadCommandCallback`to handle load and resume session requests.
void	setMediaStatusInterceptor(MediaManager.MediaStatusInterceptor interceptor) Sets the`MediaManager.MediaStatusInterceptor`to intercept and modify the `MediaStatus` before it is being sent out.
void	setSessionCompatToken(MediaSessionCompat.Token token) Sets and attaches to a MediaSession token.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Objectarg0)
void	finalize()
finalClass<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public voidbroadcastMediaStatus()

Trigger a media status broadcast.

The broadcastedMediaStatus is generated in the following steps:

The library generates the baseMediaStatus based on the currentMediaSessionCompatinformation.
The library applies the overrides fromMediaStatusModifier andMediaQueueManager.
The library invokes theMediaManager.MediaStatusInterceptorto apply final changes to the MediaStatus.
Send theMediaStatus to the senders.

publicMediaStatus getBaseMediaStatus()

Returns the baseMediaStatus which is generated from Android MediaSession, before applying any overrides from MediaStatusModifier, MediaQueueManager orMediaManager.MediaStatusInterceptor.

Returnsnullif no MediaSession attached or no metadata or playback state from MediaSession.

The following common commands are always added to the baseMediaStatus by default (You can still override these commands via theMediaStatusModifier):

publicMediaStatus getCurrentMediaStatus()

Returns the currentMediaStatus generated from the baseMediaStatus with overrides applied fromMediaStatusModifier andMediaQueueManager (note that changes fromMediaManager.MediaStatusInterceptoris not applied).

Returnsnullif no MediaSession attached or no metadata or playback state from MediaSession.

publicMediaQueueManager getMediaQueueManager()

Returns theMediaQueueManager.

SeeMediaQueueManager for details about the queue manager.

SeebroadcastMediaStatus()for howMediaStatus is processed.

publicMediaStatusModifier getMediaStatusModifier()

Returns theMediaStatusModifier.

SeeMediaStatusModifier for details about the modifier.

SeebroadcastMediaStatus()for howMediaStatus is processed.

public booleanonNewIntent(Intent intent)

Passes a new activity intent toMediaManager. If it is a supported load or resume session intent, it will be notified via callbacks inMediaCommandCallback.

Returns

trueif the intent is handled by the SDK

public voidsetDataFromLoad(MediaLoadRequestData loadRequestData)

InitializesMediaStatusModifier andMediaQueueManager overrides using the information from a load request.

All current overrides inMediaStatusModifier andMediaQueueManager will be cleared after this method call.

MediaStatusModifier will set theMediaInfo and tracks information from the load request.
MediaQueueManager will set the queue items, queue status, etc. from the load request. Note that MediaQueueManager will automatically assign item IDs to the queue items. The auto-assignment is internally done by callingMediaQueueManager.autoGenerateItemId().You can also opt-out by assigning item IDs by yourself. This can be done by usingMediaQueueItemWriter to modify the queue items obtained fromMediaQueueManager.getQueueItems().

See


MediaStatusModifier.clear()

about clearing overrides inMediaStatusModifier.

SeeMediaQueueManager.clear()about clearing overrides inMediaQueueManager.

SeeMediaQueueManager.autoGenerateItemId()about auto-generation of item IDs.

public voidsetMediaCommandCallback(MediaCommandCallback callback)

Sets theMediaCommandCallback. Setting tonullresets to the default implementation.

The default implementation translates cast commands intoMediaControllerCompat.TransportControlscommands.

public voidsetMediaLoadCommandCallback(MediaLoadCommandCallback callback)

Sets theMediaLoadCommandCallbackto handle load and resume session requests. Setting tonullresets the default implementation.

The default implementation fails all requests.

public voidsetMediaStatusInterceptor(MediaManager.MediaStatusInterceptor interceptor)

Sets theMediaManager.MediaStatusInterceptorto intercept and modify the MediaStatus before it is being sent out.

The interceptor operates on aMediaStatus after applying overrides fromMediaStatusModifier andMediaQueueManager.

public voidsetSessionCompatToken(MediaSessionCompat.Token token)

Sets and attaches to a MediaSession token. Setting tonulldetaches the library from the current MediaSession token.