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 |
removeOnActiveChangeListener(listener: |