Added in API level 21

Summary: Nested Classes | Methods | Inherited Methods

MediaSessionManager

Kotlin |Java

public final class MediaSessionManager
extends Object

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

Provides support for interacting with media sessions that applications have published to express their ongoing media playback state.

See also:

MediaSession
MediaController

Summary

Nested classes
`interface`	`MediaSessionManager.OnActiveSessionsChangedListener` Listens for changes to the list of active sessions.
`interface`	`MediaSessionManager.OnMediaKeyEventSessionChangedListener` Listener to receive changes in the media key event session, which would receive a media key event unless specified.
`interface`	`MediaSessionManager.OnSession2TokensChangedListener` This API is not generally intended for third party application developers.
`class`	`MediaSessionManager.RemoteUserInfo` Information of a remote user of `MediaSession` or `MediaBrowserService`.

Public methods
`void`	`addOnActiveSessionsChangedListener(MediaSessionManager.OnActiveSessionsChangedListener sessionListener, ComponentName notificationListener)` Add a listener to be notified when the list of active sessions changes.
`void`	`addOnActiveSessionsChangedListener(MediaSessionManager.OnActiveSessionsChangedListener sessionListener, ComponentName notificationListener, Handler handler)` Add a listener to be notified when the list of active sessions changes.
`void`	`addOnMediaKeyEventSessionChangedListener(Executor executor, MediaSessionManager.OnMediaKeyEventSessionChangedListener listener)` Add a listener to be notified when the media key session is changed.
`void`	`addOnSession2TokensChangedListener(MediaSessionManager.OnSession2TokensChangedListener listener)` This API is not generally intended for third party application developers.
`void`	`addOnSession2TokensChangedListener(MediaSessionManager.OnSession2TokensChangedListener listener, Handler handler)` This API is not generally intended for third party application developers.
`List<MediaController>`	`getActiveSessions(ComponentName notificationListener)` Get a list of controllers for all ongoing sessions.
`MediaSession.Token`	`getMediaKeyEventSession()` Gets the media key event session, which would receive a media key event unless specified.
`String`	`getMediaKeyEventSessionPackageName()` Gets the package name of the media key event session.
`List<Session2Token>`	`getSession2Tokens()` This API is not generally intended for third party application developers.
`boolean`	`isTrustedForMediaControl(MediaSessionManager.RemoteUserInfo userInfo)` Checks whether the remote user is a trusted app.
`void`	`notifySession2Created(Session2Token token)` This method was deprecated in API level 31. Don't use this method. A new media session is notified automatically.
`void`	`removeOnActiveSessionsChangedListener(MediaSessionManager.OnActiveSessionsChangedListener sessionListener)` Stop receiving active sessions updates on the specified listener.
`void`	`removeOnMediaKeyEventSessionChangedListener(MediaSessionManager.OnMediaKeyEventSessionChangedListener listener)` Stop receiving updates on media key event session change on the specified listener.
`void`	`removeOnSession2TokensChangedListener(MediaSessionManager.OnSession2TokensChangedListener listener)` This API is not generally intended for third party application developers.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

addOnActiveSessionsChangedListener

Added in API level 21

public void addOnActiveSessionsChangedListener (MediaSessionManager.OnActiveSessionsChangedListener sessionListener, 
                ComponentName notificationListener)

Add a listener to be notified when the list of active sessions changes.

This requires the Manifest.permission.MEDIA_CONTENT_CONTROL permission be held by the calling app. You may also retrieve this list if your app is an enabled notificationlistener using the NotificationListenerService APIs, in which case you must pass the ComponentName of your enabled listener.

Parameters
`sessionListener`	`MediaSessionManager.OnActiveSessionsChangedListener`: The listener to add. This value cannot be `null`.
`notificationListener`	`ComponentName`: The enabled notification listener component. May be null.

addOnActiveSessionsChangedListener

Added in API level 21

public void addOnActiveSessionsChangedListener (MediaSessionManager.OnActiveSessionsChangedListener sessionListener, 
                ComponentName notificationListener, 
                Handler handler)

Add a listener to be notified when the list of active sessions changes.

This requires the Manifest.permission.MEDIA_CONTENT_CONTROL permission be held by the calling app. You may also retrieve this list if your app is an enabled notification listener using the NotificationListenerService APIs, in which case you must pass the ComponentName of your enabled listener. Updates will be posted to the handler specified or to the caller's thread if the handler is null.

Parameters
`sessionListener`	`MediaSessionManager.OnActiveSessionsChangedListener`: The listener to add. This value cannot be `null`.
`notificationListener`	`ComponentName`: The enabled notification listener component. May be null.
`handler`	`Handler`: The handler to post events to. This value may be `null`.

addOnMediaKeyEventSessionChangedListener

Added in API level 33

public void addOnMediaKeyEventSessionChangedListener (Executor executor, 
                MediaSessionManager.OnMediaKeyEventSessionChangedListener listener)

Add a listener to be notified when the media key session is changed.

This requires the Manifest.permission.MEDIA_CONTENT_CONTROL permission be held by the calling app, or the app has an enabled notification listener using the NotificationListenerService APIs. If none of them applies, it will throw a SecurityException.

Parameters
`executor`	`Executor`: The executor on which the listener should be invoked. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`listener`	`MediaSessionManager.OnMediaKeyEventSessionChangedListener`: A `OnMediaKeyEventSessionChangedListener`. This value cannot be `null`.

addOnSession2TokensChangedListener

Added in API level 29

public void addOnSession2TokensChangedListener (MediaSessionManager.OnSession2TokensChangedListener listener)

This API is not generally intended for third party application developers. Use the AndroidX Media2 session Library for consistent behavior across all devices.

Adds a listener to be notified when the getSession2Tokens() changes.

Parameters
`listener`	`MediaSessionManager.OnSession2TokensChangedListener`: The listener to add This value cannot be `null`.

addOnSession2TokensChangedListener

Added in API level 29

public void addOnSession2TokensChangedListener (MediaSessionManager.OnSession2TokensChangedListener listener, 
                Handler handler)

This API is not generally intended for third party application developers. Use the AndroidX Media2 session Library for consistent behavior across all devices.

Adds a listener to be notified when the getSession2Tokens() changes.

Parameters
`listener`	`MediaSessionManager.OnSession2TokensChangedListener`: The listener to add This value cannot be `null`.
`handler`	`Handler`: The handler to call listener on. This value cannot be `null`.

getActiveSessions

Added in API level 21

public List<MediaController> getActiveSessions (ComponentName notificationListener)

Get a list of controllers for all ongoing sessions. The controllers will be provided in priority order with the most important controller at index 0.

This requires the Manifest.permission.MEDIA_CONTENT_CONTROL permission be held by the calling app. You may also retrieve this list if your app is an enabled notification listener using the NotificationListenerService APIs, in which case you must pass the ComponentName of your enabled listener.

Parameters
`notificationListener`	`ComponentName`: The enabled notification listener component. May be null.

Returns
`List<MediaController>`	A list of controllers for ongoing sessions. This value cannot be `null`.

getMediaKeyEventSession

Added in API level 33

public MediaSession.Token getMediaKeyEventSession ()

Gets the media key event session, which would receive a media key event unless specified.

Returns
`MediaSession.Token`	The media key event session, which would receive key events by default, unless the caller has specified the target. Can be `null`.

getMediaKeyEventSessionPackageName

Added in API level 33

public String getMediaKeyEventSessionPackageName ()

Gets the package name of the media key event session.

Returns
`String`	The package name of the media key event session or the last session's media button receiver if the media key event session is `null`. Returns an empty string if neither of them exists.

See also:

getMediaKeyEventSession()

getSession2Tokens

Added in API level 29

public List<Session2Token> getSession2Tokens ()

This API is not generally intended for third party application developers. Use the AndroidX Media2 session Library for consistent behavior across all devices.

Gets a list of Session2Token with type Session2Token#TYPE_SESSION for the current user.

Although this API can be used without any restriction, each session owners can accept or reject your uses of MediaSession2.

Returns
`List<Session2Token>`	A list of `Session2Token`. This value cannot be `null`.

isTrustedForMediaControl

Added in API level 28

public boolean isTrustedForMediaControl (MediaSessionManager.RemoteUserInfo userInfo)

Checks whether the remote user is a trusted app.

An app is trusted if the app holds the Manifest.permission.MEDIA_CONTENT_CONTROL permission or has an enabled notification listener.

Parameters
`userInfo`	`MediaSessionManager.RemoteUserInfo`: The remote user info from either `MediaSession#getCurrentControllerInfo()` or `MediaBrowserService#getCurrentBrowserInfo()`. This value cannot be `null`.

Returns
`boolean`	`true` if the remote user is trusted and its package name matches with the UID. `false` otherwise.

notifySession2Created

Added in API level 29
Deprecated in API level 31

public void notifySession2Created (Session2Token token)

This method was deprecated in API level 31.
Don't use this method. A new media session is notified automatically.

This API is not generally intended for third party application developers. Use the AndroidX Media2 session Library for consistent behavior across all devices.

Notifies that a new MediaSession2 with type Session2Token#TYPE_SESSION is created.

Do not use this API directly, but create a new instance through the MediaSession2.Builder instead.

Parameters
`token`	`Session2Token`: newly created session2 token This value cannot be `null`.

removeOnActiveSessionsChangedListener

Added in API level 21

public void removeOnActiveSessionsChangedListener (MediaSessionManager.OnActiveSessionsChangedListener sessionListener)

Stop receiving active sessions updates on the specified listener.

Parameters
`sessionListener`	`MediaSessionManager.OnActiveSessionsChangedListener`: The listener to remove. This value cannot be `null`.

removeOnMediaKeyEventSessionChangedListener

Added in API level 33

public void removeOnMediaKeyEventSessionChangedListener (MediaSessionManager.OnMediaKeyEventSessionChangedListener listener)

Stop receiving updates on media key event session change on the specified listener.

Parameters
`listener`	`MediaSessionManager.OnMediaKeyEventSessionChangedListener`: A `OnMediaKeyEventSessionChangedListener`. This value cannot be `null`.

removeOnSession2TokensChangedListener

Added in API level 29

public void removeOnSession2TokensChangedListener (MediaSessionManager.OnSession2TokensChangedListener listener)

This API is not generally intended for third party application developers. Use the AndroidX Media2 session Library for consistent behavior across all devices.

Removes the OnSession2TokensChangedListener to stop receiving session token updates.

Parameters
`listener`	`MediaSessionManager.OnSession2TokensChangedListener`: The listener to remove. This value cannot be `null`.

MediaSessionManager

Summary

Nested classes

Public methods

Inherited methods

Public methods

addOnActiveSessionsChangedListener

addOnActiveSessionsChangedListener

addOnMediaKeyEventSessionChangedListener

addOnSession2TokensChangedListener

addOnSession2TokensChangedListener

getActiveSessions

getMediaKeyEventSession

getMediaKeyEventSessionPackageName

getSession2Tokens

isTrustedForMediaControl

notifySession2Created

removeOnActiveSessionsChangedListener

removeOnMediaKeyEventSessionChangedListener

removeOnSession2TokensChangedListener