MediaLibrarySession

Kotlin |Java

class MediaLibrarySession : MediaSession

kotlin.Any
↳	androidx.media2.session.MediaSession
	↳	androidx.media2.session.MediaLibraryService.MediaLibrarySession

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

Backward compatibility with legacy media browser APIs

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

SDK version	`ControllerInfo#getPackageName()` for legacy browser	`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	`RemoteUserInfo#LEGACY_CONTROLLER`	Negative value
28 ≥ `SDK_VERSION`	Actual package name via `Context#getPackageName()`	Actual UID

Summary

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

Public methods
Unit	`notifyChildrenChanged(@NonNull controller: MediaSession.ControllerInfo, @NonNull parentId: String, @IntRange(0) itemCount: Int, @Nullable params: MediaLibraryService.LibraryParams?)` Notifies the controller of the change in a parent's children.
Unit	`notifyChildrenChanged(@NonNull parentId: String, itemCount: Int, @Nullable params: MediaLibraryService.LibraryParams?)` 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).
Unit	`notifySearchResultChanged(@NonNull controller: MediaSession.ControllerInfo, @NonNull query: String, @IntRange(0) itemCount: Int, @Nullable params: MediaLibraryService.LibraryParams?)` Notifies controller about change in the search result.

Inherited functions

From class MediaSession

`Unit`	`broadcastCustomCommand(@NonNull command: SessionCommand, @Nullable args: Bundle?)` Broadcasts a custom command to all connected controllers. This is synchronous call and doesn't wait for result from the controller. Use `sendCustomCommand(ControllerInfo, SessionCommand, Bundle)` for getting the result. A command is not accepted if it is not a custom command.
`Unit`	`close()`
`MutableList<MediaSession.ControllerInfo!>`	`getConnectedControllers()` Returns the list of connected controller.
`String`	`getId()` Gets the session ID
`SessionPlayer`	`getPlayer()` Gets the underlying `SessionPlayer`. When the session is closed, it returns the lastly set player.
`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!>`