MediaLibraryService.MediaLibrarySession
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 bothMediaBrowser
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 andMediaLibrarySessionCallback#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 |
class |
MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback
Callback for the |
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
|
void
|
notifySearchResultChanged(MediaSession.ControllerInfo controller, String query, int itemCount, MediaLibraryService.LibraryParams params)
Notifies controller about change in the search result. |
Inherited methods | |
---|---|
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
|
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-02-24 UTC.