MediaSession

FLAG_HANDLES_MEDIA_BUTTONS

static val FLAG_HANDLES_MEDIA_BUTTONS: Int

Deprecated: 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.

Value: 1

FLAG_HANDLES_TRANSPORT_CONTROLS

static val FLAG_HANDLES_TRANSPORT_CONTROLS: Int

Deprecated: 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 Callback.

Value: 2

MediaSession

MediaSession(
    context: Context, 
    tag: String)

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.

Note that RuntimeException will be thrown if an app creates too many sessions.

MediaSession

MediaSession(
    context: Context, 
    tag: String, 
    sessionInfo: Bundle?)

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.

The sessionInfo can include additional unchanging information about this session. For example, it can include the version of the application, or the list of the custom commands that this session supports.

Note that RuntimeException will be thrown if an app creates too many sessions.

getController

fun getController(): MediaController

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

getCurrentControllerInfo

fun getCurrentControllerInfo(): MediaSessionManager.RemoteUserInfo

Gets the controller information who sent the current request.

Note: This is only valid while in a request callback, such as Callback#onPlay.

getSessionToken

fun getSessionToken(): MediaSession.Token

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.

isActive

fun isActive(): Boolean

Get the current active state of this session.

release

fun release(): Unit

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

fun sendSessionEvent(
    event: String, 
    extras: Bundle?
): Unit

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.

setActive

fun setActive(active: Boolean): Unit

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.

setCallback

fun setCallback(callback: MediaSession.Callback?): Unit

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.

setCallback

fun setCallback(
    callback: MediaSession.Callback?, 
    handler: Handler?
): Unit

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.

setExtras

fun setExtras(extras: Bundle?): Unit

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.

setFlags

fun setFlags(flags: Int): Unit

Set any flags for the session.

setMediaButtonBroadcastReceiver

fun setMediaButtonBroadcastReceiver(broadcastReceiver: ComponentName?): Unit

Set the component name of the manifest-declared android.content.BroadcastReceiver class that should receive media buttons. This allows restarting playback after the session has been stopped. If your app is started in this way an Intent#ACTION_MEDIA_BUTTON intent will be sent to the broadcast receiver. On apps targeting Android U and above, this will throw an IllegalArgumentException if the provided ComponentName does not resolve to an existing broadcast receiver.

Note: The given android.content.BroadcastReceiver should belong to the same package as the context that was given when creating MediaSession.

setMediaButtonReceiver

fun setMediaButtonReceiver(mbr: PendingIntent?): Unit

Deprecated: Use setMediaButtonBroadcastReceiver(android.content.ComponentName) instead.

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 Intent#ACTION_MEDIA_BUTTON intent will be sent via the pending intent.

The provided PendingIntent must not target an activity. On apps targeting Android V and above, passing an activity pending intent to this method causes an IllegalArgumentException. On apps targeting Android U and below, passing an activity pending intent causes the call to be ignored. Refer to this guide for more information.

The pending intent is recommended to be explicit to follow the security recommendation of PendingIntent#getService.

setMetadata

fun setMetadata(metadata: MediaMetadata?): Unit

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

setPlaybackState

fun setPlaybackState(state: PlaybackState?): Unit

Update the current playback state.

setPlaybackToLocal

fun setPlaybackToLocal(attributes: AudioAttributes!): Unit

Set the attributes for this session's audio. This will affect the system's volume handling for this session. If setPlaybackToRemote 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.

setPlaybackToRemote

fun setPlaybackToRemote(volumeProvider: VolumeProvider): Unit

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 was previously called the system will stop handling volume changes for this session and pass them to the volume provider instead.

setQueue

fun setQueue(queue: MutableList<MediaSession.QueueItem!>?): Unit

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.

setQueueTitle

fun setQueueTitle(title: CharSequence?): Unit

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.

setRatingType

fun setRatingType(type: Int): Unit

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#RATING_NONE
• Rating#RATING_3_STARS
• Rating#RATING_4_STARS
• Rating#RATING_5_STARS
• Rating#RATING_HEART
• Rating#RATING_PERCENTAGE
• Rating#RATING_THUMB_UP_DOWN

setSessionActivity

fun setSessionActivity(pi: PendingIntent?): Unit

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 android.app.Activity#startActivity(android.content.Intent).