MediaSessionCompat
open class MediaSessionCompat
kotlin.Any | |
↳ | android.support.v4.media.session.MediaSessionCompat |
Allows interaction with media controllers, volume keys, media buttons, and transport controls.
A MediaSession should be created when an app wants to publish media playback information or handle media keys. In general an app only needs one session for all playback, though multiple sessions can be created to provide finer grain controls of media.
Once a session is created the owner of the session may pass its session token
to other processes to allow them to create a MediaControllerCompat
to interact with the session.
To receive commands, media keys, and other events a Callback
must be set with setCallback(Callback)
.
When an app is finished performing playback it must call release()
to clean up the session and notify any controllers.
MediaSessionCompat objects are not thread safe and all calls should be made from the same thread.
This is a helper for accessing features in android.media.session.MediaSession
introduced after API level 4 in a backwards compatible fashion.
Summary
Nested classes |
|
---|---|
abstract |
Receives transport controls, media buttons, and commands from controllers and the system. |
abstract | |
A single item that is part of the play queue. |
|
Represents an ongoing session. |
Constants |
|
---|---|
static String |
Predefined custom action to flag the media that is currently playing as inappropriate. |
static String |
Predefined custom action to follow an artist, album, or playlist. |
static String |
Predefined custom action to skip the advertisement that is currently playing. |
static String |
Predefined custom action to unfollow an artist, album, or playlist. |
static String |
Argument to indicate the media attribute. |
static String |
String argument to indicate the value of the media attribute (e.g., the name of the artist). |
static Int |
Sets this flag on the session to indicate that it can handle media button events. |
static Int |
Sets this flag on the session to indicate that it handles queue management commands through its |
static Int |
Sets this flag on the session to indicate that it handles transport control commands through its |
static Int |
The value of |
static Int |
The value of |
static Int |
The value of |
Public constructors |
|
---|---|
Creates a new session. |
|
<init>(@NonNull context: Context, @NonNull tag: String, @Nullable mbrComponent: ComponentName?, @Nullable mbrIntent: PendingIntent?) Creates a new session with a specified media button receiver (a component name and/or a pending intent). |
Public methods |
|
---|---|
open Unit |
Adds a listener to be notified when the active status of this session changes. |
open static MediaSessionCompat! |
fromMediaSession(context: Context!, mediaSession: Any!) Creates an instance from a framework |
open MediaControllerCompat! |
Gets a controller for this session. |
MediaSessionManager.RemoteUserInfo |
Gets the controller information who sent the current request. |
open Any! |
Gets the underlying framework |
open Any! |
Gets the underlying framework |
open MediaSessionCompat.Token! |
Retrieves a token object that can be used by apps to create a |
open Boolean |
isActive() Gets the current active state of this session. |
open Unit |
release() This must be called when an app has finished performing playback. |
open Unit |
Stops the listener from being notified when the active status of this session changes. |
open Unit |
sendSessionEvent(event: String!, extras: Bundle!) Sends a proprietary event to all MediaControllers listening to this Session. |
open Unit |
Sets if this session is currently active and ready to receive commands. |
open Unit |
setCallback(callback: MediaSessionCompat.Callback!) Adds a callback to receive updates on for the MediaSession. |
open Unit |
setCallback(callback: MediaSessionCompat.Callback!, handler: Handler!) Sets the callback to receive updates for the MediaSession. |
open Unit |
setCaptioningEnabled(enabled: Boolean) Enables/disables captioning for this session. |
open Unit |
Sets some extras that can be associated with the |
open Unit |
Sets any flags for the session. |
open Unit |
Sets a pending intent for your media button receiver to allow restarting playback after the session has been stopped. |
open Unit |
setMetadata(metadata: MediaMetadataCompat!) Updates the current metadata. |
open Unit |
setPlaybackState(state: PlaybackStateCompat!) Updates the current playback state. |
open Unit |
setPlaybackToLocal(stream: Int) Sets the stream this session is playing on. |
open Unit |
setPlaybackToRemote(volumeProvider: VolumeProviderCompat!) Configures this session to use remote volume handling. |
open Unit |
setQueue(queue: MutableList<MediaSessionCompat.QueueItem!>!) Updates the list of items in the play queue. |
open Unit |
setQueueTitle(title: CharSequence!) Sets the title of the play queue. |
open Unit |
setRatingType(type: Int) Sets the style of rating used by this session. |
open Unit |
setRepeatMode(repeatMode: Int) Sets the repeat mode for this session. |
open Unit |
Sets an intent for launching UI for this Session. |
open Unit |
setShuffleMode(shuffleMode: Int) Sets the shuffle mode for this session. |
Constants
ACTION_FLAG_AS_INAPPROPRIATE
static val ACTION_FLAG_AS_INAPPROPRIATE: String
Predefined custom action to flag the media that is currently playing as inappropriate.
Value: "android.support.v4.media.session.action.FLAG_AS_INAPPROPRIATE"
See Also
ACTION_FOLLOW
static val ACTION_FOLLOW: String
Predefined custom action to follow an artist, album, or playlist. The extra bundle must have ARGUMENT_MEDIA_ATTRIBUTE
to indicate the type of the follow action. The bundle can also have an optional string argument, ARGUMENT_MEDIA_ATTRIBUTE_VALUE
, to specify the target to follow (e.g., the name of the artist to follow). If this argument is omitted, the currently playing media will be the target of the action. Thus, the session must perform the follow action with the current metadata. If there's no specified attribute in the current metadata, the controller must not omit this argument.
Value: "android.support.v4.media.session.action.FOLLOW"
ACTION_SKIP_AD
static val ACTION_SKIP_AD: String
Predefined custom action to skip the advertisement that is currently playing.
Value: "android.support.v4.media.session.action.SKIP_AD"
See Also
ACTION_UNFOLLOW
static val ACTION_UNFOLLOW: String
Predefined custom action to unfollow an artist, album, or playlist. The extra bundle must have ARGUMENT_MEDIA_ATTRIBUTE
to indicat