Summary: Nested Classes | Methods | Inherited Methods

MediaLibraryService.MediaLibrarySession

Kotlin |Java

public static final class MediaLibraryService.MediaLibrarySession
extends MediaSession

java.lang.Object
↳	androidx.media2.session.MediaSession
	↳	androidx.media2.session.MediaLibraryService.MediaLibrarySession

Session for the MediaLibraryService. Build this object with MediaLibraryService.MediaLibrarySession.Builder and return in MediaSessionService.onGetSession(ControllerInfo).

Backward compatibility with legacy media browser APIs

Media library session supports connection from both MediaBrowser and MediaBrowserCompat, but MediaSession.ControllerInfo may not be precise. Here are current limitations with details.

SDK version	`MediaSession.ControllerInfo.getPackageName()` for legacy browser	`MediaSession.ControllerInfo.getUid()` for legacy browser
`SDK_VERSION` < 21	Actual package name via `Context.getPackageName()`	Actual UID
21 ≥ `SDK_VERSION` < 28, `MediaLibrarySessionCallback#onConnect` and `MediaLibrarySessionCallback#onGetLibraryRoot`	Actual package name via `Context.getPackageName()`	Actual UID
21 ≥ `SDK_VERSION` < 28, for other callbacks	`MediaSessionManager.RemoteUserInfo.LEGACY_CONTROLLER`	Negative value
28 ≥ `SDK_VERSION`	Actual package name via `Context.getPackageName()`	Actual UID

Summary

Nested classes
`class`	`MediaLibraryService.MediaLibrarySession.Builder` Builder for `MediaLibraryService.MediaLibrarySession`.
`class`	`MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback` Callback for the `MediaLibraryService.MediaLibrarySession`.

Public methods
`void`	`notifyChildrenChanged(MediaSession.ControllerInfo controller, String parentId, int itemCount, MediaLibraryService.LibraryParams params)` Notifies the controller of the change in a parent's children.
`void`	`notifyChildrenChanged(String parentId, int itemCount, MediaLibraryService.LibraryParams params)` Notifies all controllers that subscribed to the parent about change in the parent's children, regardless of the library params supplied by `MediaBrowser.subscribe(String, LibraryParams)`.
`void`	`notifySearchResultChanged(MediaSession.ControllerInfo controller, String query, int itemCount, MediaLibraryService.LibraryParams params)` Notifies controller about change in the search result.

Inherited methods

From class


        
          androidx.media2.session.MediaSession

`void`	`broadcastCustomCommand(SessionCommand command, Bundle args)` Broadcasts a custom command to all connected controllers.
`void`	`close()`
`List<MediaSession.ControllerInfo>`	`getConnectedControllers()` Returns the list of connected controller.
`String`	`getId()` Gets the session ID
`SessionPlayer`	`getPlayer()` Gets the underlying `SessionPlayer`.
`MediaSessionCompat.Token`	`getSessionCompatToken()` Gets the `MediaSessionCompat.Token` for the MediaSessionCompat created internally by this session.
`SessionToken`	`getToken()` Returns the `SessionToken` for creating `MediaController`.
`ListenableFuture<SessionResult>`	`sendCustomCommand(MediaSession.ControllerInfo controller, SessionCommand command, Bundle args)` Sends a custom command to a specific controller.
`void`	`setAllowedCommands(MediaSession.ControllerInfo controller, SessionCommandGroup commands)` Sets the new allowed command group for the controller.
`ListenableFuture<SessionResult>`	`setCustomLayout(MediaSession.ControllerInfo controller, List<MediaSession.CommandButton> layout)` Sets ordered list of `MediaSession.CommandButton` for controllers to build UI with it.
`void`	`updatePlayer(SessionPlayer player)` Updates the underlying `SessionPlayer` for this session to dispatch incoming event to.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          java.io.Closeable

abstract void close()

From interface


        
          java.lang.AutoCloseable

abstract void close()

Public methods

notifyChildrenChanged

public void notifyChildrenChanged (MediaSession.ControllerInfo controller, 
                String parentId, 
                int itemCount, 
                MediaLibraryService.LibraryParams params)

Notifies the controller of the change in a parent's children.

If the controller hasn't subscribed to the parent, the API will do nothing.

Controllers will use MediaBrowser.getChildren(String, int, int, LibraryParams) to get the list of children.

Parameters
`controller`	`MediaSession.ControllerInfo`: controller to notify
`parentId`	`String`: non-empty parent id with changes in its children
`itemCount`	`int`: number of children.
`params`	`MediaLibraryService.LibraryParams`: library params

notifyChildrenChanged

public void notifyChildrenChanged (String parentId, 
                int itemCount, 
                MediaLibraryService.LibraryParams params)

Notifies all controllers that subscribed to the parent about change in the parent's children, regardless of the library params supplied by MediaBrowser.subscribe(String, LibraryParams).

Parameters
`parentId`	`String`: non-empty parent id
`itemCount`	`int`: number of children
`params`	`MediaLibraryService.LibraryParams`: library params

notifySearchResultChanged

public void notifySearchResultChanged (MediaSession.ControllerInfo controller, 
                String query, 
                int itemCount, 
                MediaLibraryService.LibraryParams params)

Notifies controller about change in the search result.

Parameters
`controller`	`MediaSession.ControllerInfo`: controller to notify
`query`	`String`: previously sent non-empty search query from the controller.
`itemCount`	`int`: the number of items that have been found in the search.
`params`	`MediaLibraryService.LibraryParams`: library params

MediaLibraryService.MediaLibrarySession

Backward compatibility with legacy media browser APIs

Summary

Nested classes

Public methods

Inherited methods

Public methods

notifyChildrenChanged

notifyChildrenChanged

notifySearchResultChanged