MediaSessionCompat

Kotlin |Java

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.

Developer Guides

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

Summary

Nested classes
abstract	Callback Receives transport controls, media buttons, and commands from controllers and the system.
abstract	OnActiveChangeListener
	QueueItem A single item that is part of the play queue.
	Token Represents an ongoing session.

Constants
static String	ACTION_FLAG_AS_INAPPROPRIATE Predefined custom action to flag the media that is currently playing as inappropriate.
static String	ACTION_FOLLOW Predefined custom action to follow an artist, album, or playlist.
static String	ACTION_SKIP_AD Predefined custom action to skip the advertisement that is currently playing.
static String	ACTION_UNFOLLOW Predefined custom action to unfollow an artist, album, or playlist.
static String	ARGUMENT_MEDIA_ATTRIBUTE Argument to indicate the media attribute.
static String	ARGUMENT_MEDIA_ATTRIBUTE_VALUE String argument to indicate the value of the media attribute (e.g., the name of the artist).
static Int	FLAG_HANDLES_MEDIA_BUTTONS Sets this flag on the session to indicate that it can handle media button events.
static Int	FLAG_HANDLES_QUEUE_COMMANDS Sets this flag on the session to indicate that it handles queue management commands through its Callback.
static Int	FLAG_HANDLES_TRANSPORT_CONTROLS Sets this flag on the session to indicate that it handles transport control commands through its Callback.
static Int	MEDIA_ATTRIBUTE_ALBUM The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the album.
static Int	MEDIA_ATTRIBUTE_ARTIST The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the artist.
static Int	MEDIA_ATTRIBUTE_PLAYLIST The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the playlist.

Public constructors
<init>(@NonNull context: Context, @NonNull tag: String) 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	addOnActiveChangeListener(listener: MediaSessionCompat.OnActiveChangeListener!) 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 android.media.session.MediaSession object.
open MediaControllerCompat!	getController() Gets a controller for this session.
MediaSessionManager.RemoteUserInfo	getCurrentControllerInfo() Gets the controller information who sent the current request.
open Any!	getMediaSession() Gets the underlying framework android.media.session.MediaSession object.
open Any!	getRemoteControlClient() Gets the underlying framework android.media.RemoteControlClient object.
open MediaSessionCompat.Token!	getSessionToken() Retrieves a token object that can be used by apps to create a MediaControllerCompat for interacting with this session.
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: