MediaSessionCompat

ACTION_FLAG_AS_INAPPROPRIATE

String ACTION_FLAG_AS_INAPPROPRIATE

Predefined custom action to flag the media that is currently playing as inappropriate.

Constant Value: "android.support.v4.media.session.action.FLAG_AS_INAPPROPRIATE"

ACTION_FOLLOW

String ACTION_FOLLOW

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.

Constant Value: "android.support.v4.media.session.action.FOLLOW"

ACTION_SKIP_AD

String ACTION_SKIP_AD

Predefined custom action to skip the advertisement that is currently playing.

Constant Value: "android.support.v4.media.session.action.SKIP_AD"

ACTION_UNFOLLOW

String ACTION_UNFOLLOW

Predefined custom action to unfollow an artist, album, or playlist. The extra bundle must have ARGUMENT_MEDIA_ATTRIBUTE to indicate the type of the unfollow action. The bundle can also have an optional string argument, ARGUMENT_MEDIA_ATTRIBUTE_VALUE, to specify the target to unfollow (e.g., the name of the artist to unfollow). If this argument is omitted, the currently playing media will be the target of the action. Thus, the session must perform the unfollow action with the current metadata. If there's no specified attribute in the current metadata, the controller must not omit this argument.

Constant Value: "android.support.v4.media.session.action.UNFOLLOW"

ARGUMENT_MEDIA_ATTRIBUTE

String ARGUMENT_MEDIA_ATTRIBUTE

Argument to indicate the media attribute. It should be one of the following:

• MEDIA_ATTRIBUTE_ARTIST
• MEDIA_ATTRIBUTE_PLAYLIST
• MEDIA_ATTRIBUTE_ALBUM

Constant Value: "android.support.v4.media.session.ARGUMENT_MEDIA_ATTRIBUTE"

ARGUMENT_MEDIA_ATTRIBUTE_VALUE

String ARGUMENT_MEDIA_ATTRIBUTE_VALUE

String argument to indicate the value of the media attribute (e.g., the name of the artist).

Constant Value: "android.support.v4.media.session.ARGUMENT_MEDIA_ATTRIBUTE_VALUE"

FLAG_HANDLES_MEDIA_BUTTONS

int FLAG_HANDLES_MEDIA_BUTTONS

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

Constant Value: 1 (0x00000001)

FLAG_HANDLES_QUEUE_COMMANDS

int FLAG_HANDLES_QUEUE_COMMANDS

Sets this flag on the session to indicate that it handles queue management commands through its MediaSessionCompat.Callback.

Constant Value: 4 (0x00000004)

FLAG_HANDLES_TRANSPORT_CONTROLS

int FLAG_HANDLES_TRANSPORT_CONTROLS

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

Constant Value: 2 (0x00000002)

MEDIA_ATTRIBUTE_ALBUM

int MEDIA_ATTRIBUTE_ALBUM

The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the album.

Constant Value: 1 (0x00000001)

MEDIA_ATTRIBUTE_ARTIST

int MEDIA_ATTRIBUTE_ARTIST

The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the artist.

Constant Value: 0 (0x00000000)

MEDIA_ATTRIBUTE_PLAYLIST

int MEDIA_ATTRIBUTE_PLAYLIST

The value of ARGUMENT_MEDIA_ATTRIBUTE indicating the playlist.

Constant Value: 2 (0x00000002)

MediaSessionCompat

MediaSessionCompat (Context context,
                String tag)

Creates a new session. You must call release() when finished with the session.

The session will automatically be registered with the system but will not be published until setActive(true) is called.

For API 20 or earlier, note that a media button receiver is required for handling ACTION_MEDIA_BUTTON. This constructor will attempt to find an appropriate BroadcastReceiver from your manifest. See MediaButtonReceiver for more details.

MediaSessionCompat

MediaSessionCompat (Context context,
                String tag,
                ComponentName mbrComponent,
                PendingIntent mbrIntent)

Creates a new session with a specified media button receiver (a component name and/or a pending intent). You must call release() when finished with the session.

The session will automatically be registered with the system but will not be published until setActive(true) is called.

For API 20 or earlier, note that a media button receiver is required for handling ACTION_MEDIA_BUTTON. This constructor will attempt to find an appropriate BroadcastReceiver from your manifest if it's not specified. See MediaButtonReceiver for more details.

addOnActiveChangeListener

void addOnActiveChangeListener (MediaSessionCompat.OnActiveChangeListener listener)

Adds a listener to be notified when the active status of this session changes. This is primarily used by the support library and should not be needed by apps.

fromMediaSession

MediaSessionCompat fromMediaSession (Context context,
                Object mediaSession)

Creates an instance from a framework MediaSession object.

This method is only supported on API 21+. On API 20 and below, it returns null.

getController

MediaControllerCompat getController ()

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

getMediaSession

Object getMediaSession ()

Gets the underlying framework MediaSession object.

This method is only supported on API 21+.

getRemoteControlClient

Object getRemoteControlClient ()

Gets the underlying framework RemoteControlClient object.

This method is only supported on APIs 14-20. On API 21+ getMediaSession() should be used instead.

getSessionToken

MediaSessionCompat.Token getSessionToken ()

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

On platform versions before LOLLIPOP this token may only be used within your app as there is no way to guarantee other apps are using the same version of the support library.

isActive

boolean isActive ()

Gets the current active state of this session.

release

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.

removeOnActiveChangeListener

void removeOnActiveChangeListener (MediaSessionCompat.OnActiveChangeListener listener)

Stops the listener from being notified when the active status of this session changes.

sendSessionEvent

void sendSessionEvent (String event,
                Bundle extras)

Sends 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.

setActive

void setActive (boolean active)

Sets 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.

On platforms earlier than LOLLIPOP, a media button event receiver should be set via the constructor to receive media button events.

setCallback

void setCallback (MediaSessionCompat.Callback callback,
                Handler handler)

Sets the callback to receive updates for the MediaSession. This includes media button and volume events. Set the callback to null to stop receiving events.

setCallback

void setCallback (MediaSessionCompat.Callback callback)

Adds a callback to receive updates on for the MediaSession. This includes media button and volume events. The caller's thread will be used to post events.

setCaptioningEnabled

void setCaptioningEnabled (boolean enabled)

Enables/disables captioning for this session.

setExtras

void setExtras (Bundle extras)

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

setFlags

void setFlags (int flags)

Sets any flags for the session.

setMediaButtonReceiver

void setMediaButtonReceiver (PendingIntent mbr)

Sets 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.

This method will only work on LOLLIPOP and later. Earlier platform versions must include the media button receiver in the constructor.

setMetadata

void setMetadata (MediaMetadataCompat metadata)

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

setPlaybackState

void setPlaybackState (PlaybackStateCompat state)

Updates the current playback state.

setPlaybackToLocal

void setPlaybackToLocal (int stream)

Sets the stream this session is playing on. This will affect the system's volume handling for this session. If setPlaybackToRemote(VolumeProviderCompat) was previously called it will stop receiving volume commands and the system will begin sending volume changes to the appropriate stream.

By default sessions are on STREAM_MUSIC.

setPlaybackToRemote

void setPlaybackToRemote (VolumeProviderCompat volumeProvider)

Configures this session to use remote volume handling. This must be called to receive volume button events, otherwise the system will adjust the current stream volume for this session. If setPlaybackToLocal(int) was previously called that stream will stop receiving volume changes for this session.

On platforms earlier than LOLLIPOP this will only allow an app to handle volume commands sent directly to the session by a MediaControllerCompat. System routing of volume keys will not use the volume provider.

setQueue

void setQueue (List<MediaSessionCompat.QueueItem> queue)

Updates 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.

setQueueTitle

void setQueueTitle (CharSequence title)

Sets 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.

setRatingType

void setRatingType (int type)

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

• RATING_NONE
• RATING_3_STARS
• RATING_4_STARS
• RATING_5_STARS
• RATING_HEART
• RATING_PERCENTAGE
• RATING_THUMB_UP_DOWN

setRepeatMode

void setRepeatMode (int repeatMode)

Sets the repeat mode for this session.

Note that if this method is not called before, getRepeatMode() will return REPEAT_MODE_NONE.

setSessionActivity

void setSessionActivity (PendingIntent pi)

Sets 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).

setShuffleMode

void setShuffleMode (int shuffleMode)

Sets the shuffle mode for this session.

Note that if this method is not called before, getShuffleMode() will return SHUFFLE_MODE_NONE.