MediaControllerCompat

Kotlin |Java

class MediaControllerCompat

kotlin.Any
↳	android.support.v4.media.session.MediaControllerCompat

Allows an app to interact with an ongoing media session. Media buttons and other commands can be sent to the session. A callback may be registered to receive updates from the session, such as metadata and play state changes.

A MediaController can be created if you have a MediaSessionCompat.Token from the session owner.

MediaController objects are thread-safe.

This is a helper for accessing features in android.media.session.MediaSession introduced after API level 4 in a backwards compatible fashion.

If MediaControllerCompat is created with a session token from another process, following methods will not work directly after the creation if the session token is not passed through a MediaBrowserCompat:

getPlaybackState().getExtras()
getRatingType()
getRepeatMode()
getShuffleMode()
isCaptioningEnabled()

Summary

Nested classes
abstract	`Callback` Callback for receiving updates on from the session.
	`PlaybackInfo` Holds information about the way volume is handled for this session.
abstract	`TransportControls` Interface for controlling media playback on a session.

Public constructors
`<init>(context: Context!, @NonNull session: MediaSessionCompat)` Creates a media controller from a session.
`<init>(context: Context!, @NonNull sessionToken: MediaSessionCompat.Token)` Creates a media controller from a session token which may have been obtained from another process.

Public methods
Unit	`addQueueItem(description: MediaDescriptionCompat!)` Adds a queue item from the given `description` at the end of the play queue of this session.
Unit	`addQueueItem(description: MediaDescriptionCompat!, index: Int)` Adds a queue item from the given `description` at the specified position in the play queue of this session.
Unit	`adjustVolume(direction: Int, flags: Int)` Adjusts the volume of the output this session is playing on.
Boolean	`dispatchMediaButtonEvent(keyEvent: KeyEvent!)` Sends the specified media button event to the session.
Bundle!	`getExtras()` Gets the extras for this session.
Long	`getFlags()` Gets the flags for this session.
Any!	`getMediaController()` Gets the underlying framework `android.media.session.MediaController` object.
static MediaControllerCompat!	`getMediaController(@NonNull activity: Activity)` Retrieves the `MediaControllerCompat` set in the activity by `setMediaController(Activity, MediaControllerCompat)` for sending media key and volume events.
MediaMetadataCompat!	`getMetadata()` Gets the current metadata for this session.
String!	`getPackageName()` Gets the session owner's package name.
MediaControllerCompat.PlaybackInfo!	`getPlaybackInfo()` Gets the current playback info for this session.
PlaybackStateCompat!	`getPlaybackState()` Gets the current playback state for this session.
MutableList<MediaSessionCompat.QueueItem!>!	`getQueue()` Gets the current play queue for this session if one is set.
CharSequence!	`getQueueTitle()` Gets the queue title for this session.
Int	`getRatingType()` Gets the rating type supported by the session.
Int	`getRepeatMode()` Gets the repeat mode for this session.
PendingIntent!	`getSessionActivity()` Gets an intent for launching UI associated with this session if one exists.
MediaSessionCompat.Token!	`getSessionToken()` Gets the token for the session that this controller is connected to.
Int	`getShuffleMode()` Gets the shuffle mode for this session.
MediaControllerCompat.TransportControls!	`getTransportControls()` Gets a `TransportControls` instance for this session.
Boolean	`isCaptioningEnabled()` Returns whether captioning is enabled for this session.
Boolean	`isSessionReady()` Returns whether the session is ready or not.
Unit	`registerCallback(@NonNull callback: MediaControllerCompat.Callback)` Adds a callback to receive updates from the Session.
Unit	`registerCallback(@NonNull callback: MediaControllerCompat.Callback, handler: Handler!)` Adds a callback to receive updates from the session.
Unit	`removeQueueItem(description: MediaDescriptionCompat!)` Removes the first occurrence of the specified `MediaSessionCompat.QueueItem` with the given `description` in the play queue of the associated session.
Unit	`removeQueueItemAt(index: Int)` Removes an queue item at the specified position in the play queue of this session.
Unit	`sendCommand(@NonNull command: String, @Nullable params: Bundle?, @Nullable cb: ResultReceiver?)` Sends a generic command to the session.
static Unit	`setMediaController(@NonNull activity: Activity, mediaController: MediaControllerCompat!)` Sets a `MediaControllerCompat` in the `activity` for later retrieval via `getMediaController(Activity)`.
Unit	`setVolumeTo(value: Int, flags: Int)` Sets the volume of the output this session is playing on.
Unit	`unregisterCallback(@NonNull callback: MediaControllerCompat.Callback)` Stops receiving updates on the specified callback.

Public constructors

<init>

MediaControllerCompat(context: Context!, @NonNull session: MediaSessionCompat)

Creates a media controller from a session.

Parameters
`session`	Context!: The session to be controlled.

<init>

MediaControllerCompat(context: Context!, @NonNull sessionToken: MediaSessionCompat.Token)

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

Parameters
`sessionToken`	Context!: The token of the session to be controlled.

Exceptions
`RemoteException`	if the session is not accessible.

Public methods

addQueueItem

fun addQueueItem(description: MediaDescriptionCompat!): Unit

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 MediaSessionCompat#FLAG_HANDLES_QUEUE_COMMANDS is set.

Parameters
`description`	MediaDescriptionCompat!: The `MediaDescriptionCompat` for creating the `MediaSessionCompat.QueueItem` to be inserted.

Exceptions
`UnsupportedOperationException`	If this session doesn't support this.

See Also

#getFlags()MediaSessionCompat#FLAG_HANDLES_QUEUE_COMMANDS

addQueueItem

fun addQueueItem(description: MediaDescriptionCompat!, index: Int): Unit

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 MediaSessionCompat#FLAG_HANDLES_QUEUE_COMMANDS is set.

Parameters
`description`	MediaDescriptionCompat!: The `MediaDescriptionCompat` for creating the `MediaSessionCompat.QueueItem` to be inserted.
`index`	MediaDescriptionCompat!: The index at which the created `MediaSessionCompat.QueueItem` is to be inserted.

Exceptions
`UnsupportedOperationException`	If this session doesn't support this.

See Also

#getFlags()MediaSessionCompat#FLAG_HANDLES_QUEUE_COMMANDS

adjustVolume

fun adjustVolume(direction: Int, flags: Int): Unit

Adjusts the volume of the output this session is playing on. The direction must be one of AudioManager#ADJUST_LOWER,

MediaControllerCompat

Summary

Nested classes

Public constructors

Public methods

Public constructors

<init>

<init>

Public methods

addQueueItem

addQueueItem

adjustVolume