MediaControllerCompat
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 for receiving updates on from the session. |
Holds information about the way volume is handled for this session. |
|
abstract |
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 |
Unit |
addQueueItem(description: MediaDescriptionCompat!, index: Int) Adds a queue item from the given |
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! |
Gets the extras for this session. |
Long |
getFlags() Gets the flags for this session. |
Any! |
Gets the underlying framework |
static MediaControllerCompat! |
getMediaController(@NonNull activity: Activity) Retrieves the |
MediaMetadataCompat! |
Gets the current metadata for this session. |
String! |
Gets the session owner's package name. |
MediaControllerCompat.PlaybackInfo! |
Gets the current playback info for this session. |
PlaybackStateCompat! |
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! |
Gets the queue title for this session. |
Int |
Gets the rating type supported by the session. |
Int |
Gets the repeat mode for this session. |
PendingIntent! |
Gets an intent for launching UI associated with this session if one exists. |
MediaSessionCompat.Token! |
Gets the token for the session that this controller is connected to. |
Int |
Gets the shuffle mode for this session. |
MediaControllerCompat.TransportControls! |
Gets a |
Boolean |
Returns whether captioning is enabled for this session. |
Boolean |
Returns whether the session is ready or not. |
Unit |
registerCallback(@NonNull callback: MediaControllerCompat.Callback) Adds a callback to receive updates from the Session. |