MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback

public @NonNull LibraryResult onGetChildren(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String parentId,
    @IntRange(from = 0) int page,
    @IntRange(from = 1) int pageSize,
    @Nullable MediaLibraryService.LibraryParams params
)

Called to get children of given parent id. Return the children here for the browser.

To allow getting the children, return the LibraryResult with the RESULT_SUCCESS and the list of media item. Return an empty list for no children rather than using result code for error.

public @NonNull LibraryResult onGetItem(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String mediaId
)

Called to get an item.

To allow getting the item, return the LibraryResult with the RESULT_SUCCESS and the media item.

public @NonNull LibraryResult onGetLibraryRoot(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @Nullable MediaLibraryService.LibraryParams params
)

Called to get the root information for browsing by a MediaBrowser.

To allow browsing media information, return the LibraryResult with the RESULT_SUCCESS and the root media item with the valid media id. The media id must be included for the browser to get the children under it.

Interoperability: this callback may be called on the main thread, regardless of the callback executor.

public @NonNull LibraryResult onGetSearchResult(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String query,
    @IntRange(from = 0) int page,
    @IntRange(from = 1) int pageSize,
    @Nullable MediaLibraryService.LibraryParams params
)

Called to get the search result.

To allow getting the search result, return the LibraryResult with the RESULT_SUCCESS and the list of media item. Return an empty list for no search result rather than using result code for error.

This may be called with a query that hasn't called with onSearch, especially when search is used.

public int onSearch(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String query,
    @Nullable MediaLibraryService.LibraryParams params
)

Called when a controller requests search.

Return immediately with the result of the attempt to search with the query. Notify the number of search result through notifySearchResultChanged. MediaBrowser will ask the search result with the pagination later.

public int onSubscribe(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String parentId,
    @Nullable MediaLibraryService.LibraryParams params
)

Called when a controller subscribes to the parent.

It's your responsibility to keep subscriptions by your own and call notifyChildrenChanged when the parent is changed until it's unsubscribed.

Interoperability: This will be called when subscribe is called. However, this won't be called when subscribe is called.

public int onUnsubscribe(
    @NonNull MediaLibraryService.MediaLibrarySession session,
    @NonNull MediaSession.ControllerInfo controller,
    @NonNull String parentId
)

Called when a controller unsubscribes to the parent.

Interoperability: This wouldn't be called if unsubscribe is called while works well with unsubscribe.