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()

Developer Guides

For information about building your media application, read the Media Apps developer guide.

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.