MediaSessionCompat

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

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

Creates a new session.

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.

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

Gets the underlying framework MediaSession object.

This method is only supported on API 21+.

Gets the underlying framework RemoteControlClient object.

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

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

Get the current active state of this session.

Obtain a compat wrapper for an existing MediaSession.

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.

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

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.

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.

On platforms earlier than LOLLIPOP, setMediaButtonReceiver(PendingIntent) must be called before setting this to true.

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

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

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

Set any flags for the session.

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.

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

Update the current metadata. New metadata can be created using MediaMetadata.Builder.

Update the current playback state.

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

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

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.

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.

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:

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

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