MediaControllerCompat

MediaControllerCompat

MediaControllerCompat (Context context,
                MediaSessionCompat session)

Creates a media controller from a session.

MediaControllerCompat

MediaControllerCompat (Context context,
                MediaSessionCompat.Token sessionToken)

Creates a media controller from a session token which may have been obtained from another process.

addQueueItem

void addQueueItem (MediaDescriptionCompat description)

Adds a queue item from the given description at the end of the play queue of this session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags() and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

addQueueItem

void addQueueItem (MediaDescriptionCompat description,
                int index)

Adds a queue item from the given description at the specified position in the play queue of this session. Shifts the queue item currently at that position (if any) and any subsequent queue items to the right (adds one to their indices). Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags() and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

adjustVolume

void adjustVolume (int direction,
                int flags)

Adjusts the volume of the output this session is playing on. The direction must be one of ADJUST_LOWER, ADJUST_RAISE, or ADJUST_SAME. The command will be ignored if the session does not support VOLUME_CONTROL_RELATIVE or VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

dispatchMediaButtonEvent

boolean dispatchMediaButtonEvent (KeyEvent keyEvent)

Sends the specified media button event to the session. Only media keys can be sent by this method, other keys will be ignored.

getExtras

Bundle getExtras ()

Gets the extras for this session.

getFlags

long getFlags ()

Gets the flags for this session. Flags are defined in MediaSessionCompat.

getMediaController

Object getMediaController ()

Gets the underlying framework MediaController object.

This method is only supported on API 21+.

getMediaController

MediaControllerCompat getMediaController (Activity activity)

Retrieves the MediaControllerCompat set in the activity by setMediaController(Activity, MediaControllerCompat) for sending media key and volume events.

This is compatible with getMediaController().

getMetadata

MediaMetadataCompat getMetadata ()

Gets the current metadata for this session.

getPackageName

String getPackageName ()

Gets the session owner's package name.

getPlaybackInfo

MediaControllerCompat.PlaybackInfo getPlaybackInfo ()

Gets the current playback info for this session.

getPlaybackState

PlaybackStateCompat getPlaybackState ()

Gets the current playback state for this session.

If the session is not ready, getExtras() on the result of this method may return null.

getQueue

List<MediaSessionCompat.QueueItem> getQueue ()

Gets the current play queue for this session if one is set. If you only care about the current item getMetadata() should be used.

getQueueTitle

CharSequence getQueueTitle ()

Gets the queue title for this session.

getRatingType

int getRatingType ()

Gets the rating type supported by the session. One of:

• RATING_NONE
• RATING_HEART
• RATING_THUMB_UP_DOWN
• RATING_3_STARS
• RATING_4_STARS
• RATING_5_STARS
• RATING_PERCENTAGE

If the session is not ready, it will return RATING_NONE.

getRepeatMode

int getRepeatMode ()

Gets the repeat mode for this session.

getSessionActivity

PendingIntent getSessionActivity ()

Gets an intent for launching UI associated with this session if one exists.

getSessionToken

MediaSessionCompat.Token getSessionToken ()

Gets the token for the session this controller is connected to.

getShuffleMode

int getShuffleMode ()

Gets the shuffle mode for this session.

getTransportControls

MediaControllerCompat.TransportControls getTransportControls ()

Gets a MediaControllerCompat.TransportControls instance for this session.

isCaptioningEnabled

boolean isCaptioningEnabled ()

Returns whether captioning is enabled for this session.

If the session is not ready, it will return a false.

isSessionReady

boolean isSessionReady ()

Returns whether the session is ready or not.

If the session is not ready, following methods can work incorrectly.

• getPlaybackState()
• getRatingType()
• getRepeatMode()
• getShuffleMode()
• isCaptioningEnabled()

registerCallback

void registerCallback (MediaControllerCompat.Callback callback,
                Handler handler)

Adds a callback to receive updates from the session. Updates will be posted on the specified handler's thread.

registerCallback

void registerCallback (MediaControllerCompat.Callback callback)

Adds a callback to receive updates from the Session. Updates will be posted on the caller's thread.

removeQueueItem

void removeQueueItem (MediaDescriptionCompat description)

Removes the first occurrence of the specified MediaSessionCompat.QueueItem with the given description in the play queue of the associated session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags() and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

removeQueueItemAt

void removeQueueItemAt (int index)

This method was deprecated in API level 26.1.0.
Use removeQueueItem(MediaDescriptionCompat) instead.

Removes an queue item at the specified position in the play queue of this session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags() and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

sendCommand

void sendCommand (String command,
                Bundle params,
                ResultReceiver cb)

Sends a generic command to the session. It is up to the session creator to decide what commands and parameters they will support. As such, commands should only be sent to sessions that the controller owns.

setMediaController

void setMediaController (Activity activity,
                MediaControllerCompat mediaController)

Sets a MediaControllerCompat in the activity for later retrieval via getMediaController(Activity).

This is compatible with setMediaController(MediaController). If activity inherits FragmentActivity, the mediaController will be saved in the activity. In addition to that, on API 21 and later, setMediaController(MediaController) will be called.

setVolumeTo

void setVolumeTo (int value,
                int flags)

Sets the volume of the output this session is playing on. The command will be ignored if it does not support VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

unregisterCallback

void unregisterCallback (MediaControllerCompat.Callback callback)

Stops receiving updates on the specified callback. If an update has already been posted you may still receive it after calling this method.