Skip to content

Most visited

Recently visited

navigation

MediaSession

public final class MediaSession
extends Object

java.lang.Object
   ↳ android.media.session.MediaSession


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 MediaController to interact with the session.

To receive commands, media keys, and other events a MediaSession.Callback must be set with setCallback(Callback) and setActive(true) must be called.

When an app is finished performing playback it must call release() to clean up the session and notify any controllers.

MediaSession objects are thread safe.

Summary

Nested classes

class MediaSession.Callback

Receives media buttons, transport controls, and commands from controllers and the system. 

class MediaSession.QueueItem

A single item that is part of the play queue. 

class MediaSession.Token

Represents an ongoing session. 

Constants

int FLAG_HANDLES_MEDIA_BUTTONS

This constant was deprecated in API level 26. This flag is no longer used. All media sessions are expected to handle media button events now.

int FLAG_HANDLES_TRANSPORT_CONTROLS

This constant was deprecated in API level 26. This flag is no longer used. All media sessions are expected to handle transport controls now.

Public constructors

MediaSession(Context context, String tag)

Creates a new session.

Public methods

MediaController getController()

Get a controller for this session.

MediaSession.Token getSessionToken()

Retrieve a token object that can be used by apps to create a MediaController for interacting with this session.

boolean isActive()

Get the current active state of this session.

void release()

This must be called when an app has finished performing playback.

void sendSessionEvent(String event, Bundle extras)

Send a proprietary event to all MediaControllers listening to this Session.

void setActive(boolean active)

Set if this session is currently active and ready to receive commands.

void setCallback(MediaSession.Callback callback)

Set the callback to receive updates for the MediaSession.

void setCallback(MediaSession.Callback callback, Handler handler)

Set the callback to receive updates for the MediaSession.

void setExtras(Bundle extras)

Set some extras that can be associated with the MediaSession.

void setFlags(int flags)

Set any flags for the session.

void setMediaButtonReceiver(PendingIntent mbr)

Set a pending intent for your media button receiver to allow restarting playback after the session has been stopped.

void setMetadata(MediaMetadata metadata)

Update the current metadata.

void setPlaybackState(PlaybackState state)

Update the current playback state.

void setPlaybackToLocal(AudioAttributes attributes)

Set the attributes for this session's audio.

void setPlaybackToRemote(VolumeProvider volumeProvider)

Configure this session to use remote volume handling.

void setQueue(List<MediaSession.QueueItem> queue)

Update the list of items in the play queue.

void setQueueTitle(CharSequence title)

Set the title of the play queue.

void setRatingType(int type)

Set the style of rating used by this session.

void setSessionActivity(PendingIntent pi)

Set an intent for launching UI for this Session.

Inherited methods

From class java.lang.Object

Constants

FLAG_HANDLES_MEDIA_BUTTONS

added in API level 21
int FLAG_HANDLES_MEDIA_BUTTONS

This constant was deprecated in API level 26.
This flag is no longer used. All media sessions are expected to handle media button events now.

Set this flag on the session to indicate that it can handle media button events.

Constant Value: 1 (0x00000001)

FLAG_HANDLES_TRANSPORT_CONTROLS

added in API level 21
int FLAG_HANDLES_TRANSPORT_CONTROLS

This constant was deprecated in API level 26.
This flag is no longer used. All media sessions are expected to handle transport controls now.

Set this flag on the session to indicate that it handles transport control commands through its MediaSession.Callback.

Constant Value: 2 (0x00000002)

Public constructors

MediaSession

added in API level 21
MediaSession (Context context, 
                String tag)

Creates a new session. The session will automatically be registered with the system but will not be published until setActive(true) is called. You must call release() when finished with the session.

Parameters
context Context: The context to use to create the session.

This value must never be null.

tag String: A short name for debugging purposes.

This value must never be null.

Public methods

getController

added in API level 21
MediaController getController ()

Get a controller for this session. This is a convenience method to avoid having to cache your own controller in process.

Returns
MediaController A controller for this session.

This value will never be null.

getSessionToken

added in API level 21
MediaSession.Token getSessionToken ()

Retrieve a token object that can be used by apps to create a MediaController for interacting with this session. The owner of the session is responsible for deciding how to distribute these tokens.

Returns
MediaSession.Token A token that can be used to create a MediaController for this session

This value will never be null.

isActive

added in API level 21
boolean isActive ()

Get the current active state of this session.

Returns
boolean True if the session is active, false otherwise.

release

added in API level 21
void release ()

This must be called when an app has finished performing playback. If playback is expected to start again shortly the session can be left open, but it must be released if your activity or service is being destroyed.

sendSessionEvent

added in API level 21
void sendSessionEvent (String event, 
                Bundle extras)

Send a proprietary event to all MediaControllers listening to this Session. It's up to the Controller/Session owner to determine the meaning of any events.

Parameters
event String: The name of the event to send

This value must never be null.

extras Bundle: Any extras included with the event

This value may be null.

setActive

added in API level 21
void setActive (boolean active)

Set if this session is currently active and ready to receive commands. If set to false your session's controller may not be discoverable. You must set the session to active before it can start receiving media button events or transport commands.

Parameters
active boolean: Whether this session is active or not.

setCallback

added in API level 21
void setCallback (MediaSession.Callback callback)

Set the callback to receive updates for the MediaSession. This includes media button events and transport controls. The caller's thread will be used to post updates.

Set the callback to null to stop receiving updates.

Parameters
callback MediaSession.Callback: The callback object

This value may be null.

setCallback

added in API level 21
void setCallback (MediaSession.Callback callback, 
                Handler handler)

Set the callback to receive updates for the MediaSession. This includes media button events and transport controls.

Set the callback to null to stop receiving updates.

Parameters
callback MediaSession.Callback: The callback to receive updates on.

This value may be null.

handler Handler: The handler that events should be posted on.

This value may be null.

setExtras

added in API level 21
void setExtras (Bundle extras)

Set some extras that can be associated with the MediaSession. No assumptions should be made as to how a MediaController will handle these extras. Keys should be fully qualified (e.g. com.example.MY_EXTRA) to avoid conflicts.

Parameters
extras Bundle: The extras associated with the MediaSession.

This value may be null.

setFlags

added in API level 21
void setFlags (int flags)

Set any flags for the session.

Parameters
flags int: The flags to set for this session.

setMediaButtonReceiver

added in API level 21
void setMediaButtonReceiver (PendingIntent mbr)

Set a pending intent for your media button receiver to allow restarting playback after the session has been stopped. If your app is started in this way an ACTION_MEDIA_BUTTON intent will be sent via the pending intent.

Parameters
mbr PendingIntent: The PendingIntent to send the media button event to.

This value may be null.

setMetadata

added in API level 21
void setMetadata (MediaMetadata metadata)

Update the current metadata. New metadata can be created using MediaMetadata.Builder. This operation may take time proportional to the size of the bitmap to replace large bitmaps with a scaled down copy.

Parameters
metadata MediaMetadata: The new metadata

This value may be null.

See also:

setPlaybackState

added in API level 21
void setPlaybackState (PlaybackState state)

Update the current playback state.

Parameters
state PlaybackState: The current state of playback

This value may be null.

setPlaybackToLocal

added in API level 21
void setPlaybackToLocal (AudioAttributes attributes)

Set the attributes for this session's audio. This will affect the system's volume handling for this session. If setPlaybackToRemote(VolumeProvider) was previously called it will stop receiving volume commands and the system will begin sending volume changes to the appropriate stream.

By default sessions use attributes for media.

Parameters
attributes AudioAttributes: The AudioAttributes for this session's audio.

setPlaybackToRemote

added in API level 21
void setPlaybackToRemote (VolumeProvider volumeProvider)

Configure this session to use remote volume handling. This must be called to receive volume button events, otherwise the system will adjust the appropriate stream volume for this session. If setPlaybackToLocal(AudioAttributes) was previously called the system will stop handling volume changes for this session and pass them to the volume provider instead.

Parameters
volumeProvider VolumeProvider: The provider that will handle volume changes. May not be null.

setQueue

added in API level 21
void setQueue (List<MediaSession.QueueItem> queue)

Update the list of items in the play queue. It is an ordered list and should contain the current item, and previous or upcoming items if they exist. Specify null if there is no current play queue.

The queue should be of reasonable size. If the play queue is unbounded within your app, it is better to send a reasonable amount in a sliding window instead.

Parameters
queue List: A list of items in the play queue.

This value may be null.

setQueueTitle

added in API level 21
void setQueueTitle (CharSequence title)

Set the title of the play queue. The UI should display this title along with the play queue itself. e.g. "Play Queue", "Now Playing", or an album name.

Parameters
title CharSequence: The title of the play queue.

This value may be null.

setRatingType

added in API level 22
void setRatingType (int type)

Set the style of rating used by this session. Apps trying to set the rating should use this style. Must be one of the following:

Parameters
type int

setSessionActivity

added in API level 21
void setSessionActivity (PendingIntent pi)

Set an intent for launching UI for this Session. This can be used as a quick link to an ongoing media screen. The intent should be for an activity that may be started using startActivity(Intent).

Parameters
pi PendingIntent: The intent to launch to show UI for this Session.

This value may be null.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)