Summary: Ctors | Methods | Inherited Methods

MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback

Kotlin |Java

public static class MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback
extends MediaSession.SessionCallback

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

Callback for the MediaLibraryService.MediaLibrarySession.

When you return LibraryResult with media items, items must have valid MediaMetadata.METADATA_KEY_MEDIA_ID and specify MediaMetadata.METADATA_KEY_BROWSABLE and MediaMetadata.METADATA_KEY_PLAYABLE.

Summary

Public constructors
`MediaLibrarySessionCallback()`

Public methods
`LibraryResult`	`onGetChildren(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String parentId, int page, int pageSize, MediaLibraryService.LibraryParams params)` Called to get children of given parent id.
`LibraryResult`	`onGetItem(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String mediaId)` Called to get an item.
`LibraryResult`	`onGetLibraryRoot(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, MediaLibraryService.LibraryParams params)` Called to get the root information for browsing by a `MediaBrowser`.
`LibraryResult`	`onGetSearchResult(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String query, int page, int pageSize, MediaLibraryService.LibraryParams params)` Called to get the search result.
`int`	`onSearch(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String query, MediaLibraryService.LibraryParams params)` Called when a controller requests search.
`int`	`onSubscribe(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String parentId, MediaLibraryService.LibraryParams params)` Called when a controller subscribes to the parent.
`int`	`onUnsubscribe(MediaLibraryService.MediaLibrarySession session, MediaSession.ControllerInfo controller, String parentId)` Called when a controller unsubscribes to the parent.

Inherited methods

From class


        
          androidx.media2.session.MediaSession.SessionCallback

`int`	`onCommandRequest(MediaSession session, MediaSession.ControllerInfo controller, SessionCommand command)` Called when a controller sent a command which will be sent directly to one of the following: `SessionPlayer` `AudioManager` Return `SessionResult.RESULT_SUCCESS` to proceed the command.
`SessionCommandGroup`	`onConnect(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller is created for this session.
`MediaItem`	`onCreateMediaItem(MediaSession session, MediaSession.ControllerInfo controller, String mediaId)` Called when a controller has sent a command with a `MediaItem` to add a new media item to this session.
`SessionResult`	`onCustomCommand(MediaSession session, MediaSession.ControllerInfo controller, SessionCommand customCommand, Bundle args)` Called when a controller sent a custom command through `MediaController.sendCustomCommand(SessionCommand, Bundle)`.
`void`	`onDisconnected(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller is disconnected.
`int`	`onFastForward(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller called `MediaController.fastForward()`.
`void`	`onPostConnect(MediaSession session, MediaSession.ControllerInfo controller)` Called immediately after a controller is connected.
`int`	`onRewind(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller called `MediaController.rewind()`.
`int`	`onSetMediaUri(MediaSession session, MediaSession.ControllerInfo controller, Uri uri, Bundle extras)` Called when a controller requested to set the specific media item(s) represented by a URI through `MediaController.setMediaUri(Uri, Bundle)`.
`int`	`onSetRating(MediaSession session, MediaSession.ControllerInfo controller, String mediaId, Rating rating)` Called when a controller set rating of a media item through `MediaController.setRating(String, Rating)`.
`int`	`onSkipBackward(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller called `MediaController.skipBackward()`.
`int`	`onSkipForward(MediaSession session, MediaSession.ControllerInfo controller)` Called when a controller called `MediaController.skipForward()`.

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()`

Public constructors

MediaLibrarySessionCallback

public MediaLibrarySessionCallback ()

Public methods

onGetChildren

public LibraryResult onGetChildren (MediaLibraryService.MediaLibrarySession session, 
                MediaSession.ControllerInfo controller, 
                String parentId, 
                int page, 
                int pageSize, 
                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 LibraryResult.RESULT_SUCCESS and the list of media item. Return an empty list for no children rather than using result code for error.

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`parentId`	`String`: non-empty parent id to get children
`page`	`int`: page number. Starts from `0`.
`pageSize`	`int`: page size. Should be greater or equal to `1`. Value is 1 or greater.
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`LibraryResult`	a library result with a list of media item with the id. A runtime exception will be thrown if an invalid result is returned.

See also:

onGetItem

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

Called to get an item.

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

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`mediaId`	`String`: non-empty media id of the requested item

Returns
`LibraryResult`	a library result with a media item with the id. A runtime exception will be thrown if an invalid result is returned.

See also:

SessionCommand.COMMAND_CODE_LIBRARY_GET_ITEM

onGetLibraryRoot

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

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

To allow browsing media information, return the LibraryResult with the LibraryResult.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.

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: information of the controller requesting access to browse media.
`params`	`MediaLibraryService.LibraryParams`: An optional library params of service-specific arguments to send to the media library service when connecting and retrieving the root id for browsing, or `null` if none.

Returns
`LibraryResult`	a library result with the root media item with the id. A runtime exception will be thrown if an invalid result is returned.

See also:

onGetSearchResult

public LibraryResult onGetSearchResult (MediaLibraryService.MediaLibrarySession session, 
                MediaSession.ControllerInfo controller, 
                String query, 
                int page, 
                int pageSize, 
                MediaLibraryService.LibraryParams params)

Called to get the search result.

To allow getting the search result, return the LibraryResult with the LibraryResult.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(MediaLibraryService.MediaLibrarySession, MediaSession.ControllerInfo, String, MediaLibraryService.LibraryParams), especially when MediaBrowserCompat.search(String, Bundle, MediaBrowserCompat.SearchCallback) is used.

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`query`	`String`: The non-empty search query which was previously sent through `onSearch(MediaLibraryService.MediaLibrarySession, MediaSession.ControllerInfo, String, MediaLibraryService.LibraryParams)`.
`page`	`int`: page number. Starts from `0`.
`pageSize`	`int`: page size. Should be greater or equal to `1`. Value is 1 or greater.
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`LibraryResult`	a library result with a list of media item with the id. A runtime exception will be thrown if an invalid result is returned.

See also:

onSearch

public int onSearch (MediaLibraryService.MediaLibrarySession session, 
                MediaSession.ControllerInfo controller, 
                String query, 
                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 MediaLibraryService.MediaLibrarySession.notifySearchResultChanged(ControllerInfo, String, int, LibraryParams). MediaBrowser will ask the search result with the pagination later.

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`query`	`String`: The non-empty search query sent from the media browser. It contains keywords separated by space.
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`int`	result code

See also:

onSubscribe

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

Called when a controller subscribes to the parent.

It's your responsibility to keep subscriptions by your own and call MediaLibraryService.MediaLibrarySession.notifyChildrenChanged(ControllerInfo, String, int, LibraryParams) when the parent is changed until it's unsubscribed.

Interoperability: This will be called when MediaBrowserCompat.subscribe(String, Bundle, MediaBrowserCompat.SubscriptionCallback) is called. However, this won't be called when MediaBrowser.subscribe(String, MediaLibraryService.LibraryParams) is called.

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`parentId`	`String`: non-empty parent id
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`int`	result code

See also:

onUnsubscribe

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

Called when a controller unsubscribes to the parent.

Interoperability: This wouldn't be called if MediaBrowser.unsubscribe(String) is called while works well with MediaBrowserCompat.unsubscribe(String).

Parameters
`session`	`MediaLibraryService.MediaLibrarySession`: the session for this event
`controller`	`MediaSession.ControllerInfo`: controller
`parentId`	`String`: non-empty parent id

Returns
`int`	result code

See also:

SessionCommand.COMMAND_CODE_LIBRARY_UNSUBSCRIBE