Summary: Nested Classes | Methods | Inherited Methods

MediaBrowser

Kotlin |Java

public class MediaBrowser
extends MediaController

java.lang.Object
↳	androidx.media2.session.MediaController
	↳	androidx.media2.session.MediaBrowser

Browses media content offered by a MediaLibraryService.

Summary

Nested classes
`class`	`MediaBrowser.BrowserCallback` Callback to listen events from `MediaLibraryService`.
`class`	`MediaBrowser.Builder` Builder for `MediaBrowser`.

Public methods
`ListenableFuture<LibraryResult>`	`getChildren(String parentId, int page, int pageSize, MediaLibraryService.LibraryParams params)` Gets the list of children under the parent.
`ListenableFuture<LibraryResult>`	`getItem(String mediaId)` Gets the media item with the given media id.
`ListenableFuture<LibraryResult>`	`getLibraryRoot(MediaLibraryService.LibraryParams params)` Gets the library root.
`ListenableFuture<LibraryResult>`	`getSearchResult(String query, int page, int pageSize, MediaLibraryService.LibraryParams params)` Gets the search result from the library service.
`ListenableFuture<LibraryResult>`	`search(String query, MediaLibraryService.LibraryParams params)` Sends a search request to the library service.
`ListenableFuture<LibraryResult>`	`subscribe(String parentId, MediaLibraryService.LibraryParams params)` Subscribes to a parent id for the change in its children.
`ListenableFuture<LibraryResult>`	`unsubscribe(String parentId)` Unsubscribes for changes to the children of the parent, which was previously subscribed with `subscribe(String, LibraryParams)`.

Inherited methods

From class


        
          androidx.media2.session.MediaController

`ListenableFuture<SessionResult>`	`addPlaylistItem(int index, String mediaId)` Requests that the `SessionPlayer` associated with the connected `MediaSession` adds the media item to the playlist at the index with the media ID.
`ListenableFuture<SessionResult>`	`adjustVolume(int direction, int flags)` Requests that the connected `MediaSession` adjusts the volume of the output that is playing on.
`void`	`close()` Releases this object, and disconnects from the session.
`ListenableFuture<SessionResult>`	`deselectTrack(SessionPlayer.TrackInfo trackInfo)` Requests that the `SessionPlayer` associated with the connected `MediaSession` deselects the `SessionPlayer.TrackInfo` for the current media item.
`ListenableFuture<SessionResult>`	`fastForward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` to fast forward playback.
`SessionCommandGroup`	`getAllowedCommands()` Gets the cached allowed commands from `MediaController.ControllerCallback.onAllowedCommandsChanged(MediaController, SessionCommandGroup)`.
`long`	`getBufferedPosition()` Gets the position for how much has been buffered of the `SessionPlayer` associated with the connected `MediaSession`, or `SessionPlayer.UNKNOWN_TIME` if unknown or not connected.
`int`	`getBufferingState()` Gets the current buffering state of the `SessionPlayer` associated with the connected `MediaSession`.
`SessionToken`	`getConnectedToken()` Returns the `SessionToken` of the connected session.
`MediaItem`	`getCurrentMediaItem()` Gets the current media item of the `SessionPlayer` associated with the connected `MediaSession`.
`int`	`getCurrentMediaItemIndex()` Gets the current item index in the playlist of the `SessionPlayer` associated with the connected `MediaSession`.
`long`	`getCurrentPosition()` Gets the playback position of the `SessionPlayer` associated with the connected `MediaSession`.
`long`	`getDuration()` Gets the duration of the current media item, or `SessionPlayer.UNKNOWN_TIME` if unknown or not connected.
`int`	`getNextMediaItemIndex()` Gets the next item index in the playlist of the `SessionPlayer` associated with the connected `MediaSession`.
`MediaController.PlaybackInfo`	`getPlaybackInfo()` Get the current playback info for this session.
`float`	`getPlaybackSpeed()` Gets the playback speed to be used by the of the `SessionPlayer` associated with the connected `MediaSession` when playing.
`int`	`getPlayerState()` Gets the state of the `SessionPlayer` associated with the connected `MediaSession`.
`List<MediaItem>`	`getPlaylist()` Gets the playlist of the `SessionPlayer` associated with the connected `MediaSession`.
`MediaMetadata`	`getPlaylistMetadata()` Gets the playlist metadata of the `SessionPlayer` associated with the connected `MediaSession`.
`int`	`getPreviousMediaItemIndex()` Gets the previous item index in the playlist of the `SessionPlayer` associated with the connected `MediaSession`.
`int`	`getRepeatMode()` Gets the repeat mode of the `SessionPlayer` associated with the connected `MediaSession`.
`SessionPlayer.TrackInfo`	`getSelectedTrack(int trackType)` Gets the currently selected track for the given track type of the `SessionPlayer` associated with the connected `MediaSession`.
`PendingIntent`	`getSessionActivity()` Gets an intent for launching UI associated with this session if one exists.
`int`	`getShuffleMode()` Gets the shuffle mode of the `SessionPlayer` associated with the connected `MediaSession`.
`List<SessionPlayer.TrackInfo>`	`getTracks()` Gets the full list of selected and unselected tracks that the media contains of the `SessionPlayer` associated with the connected `MediaSession`.
`VideoSize`	`getVideoSize()` Gets the video size of the `SessionPlayer` associated with the connected `MediaSession`.
`boolean`	`isConnected()` Returns whether this class is connected to active `MediaSession` or not.
`ListenableFuture<SessionResult>`	`movePlaylistItem(int fromIndex, int toIndex)` Requests that the `SessionPlayer` associated with the connected `MediaSession` moves the media item at `fromIdx` to `toIdx` in the playlist.
`ListenableFuture<SessionResult>`	`pause()` Requests that the `SessionPlayer` associated with the connected `MediaSession` pauses playback.
`ListenableFuture<SessionResult>`	`play()` Requests that the `SessionPlayer` associated with the connected `MediaSession` starts or resumes playback.
`ListenableFuture<SessionResult>`	`prepare()` Requests that the `SessionPlayer` associated with the connected `MediaSession` prepares the media items for playback.
`ListenableFuture<SessionResult>`	`removePlaylistItem(int index)` Requests that the `SessionPlayer` associated with the connected `MediaSession` removes the media item at index in the playlist.
`ListenableFuture<SessionResult>`	`replacePlaylistItem(int index, String mediaId)` Requests that the `SessionPlayer` associated with the connected `MediaSession` replaces the media item at index in the playlist with the media ID.
`ListenableFuture<SessionResult>`	`rewind()` Requests that the `SessionPlayer` associated with the connected `MediaSession` to rewind playback.
`ListenableFuture<SessionResult>`	`seekTo(long position)` Requests that the `SessionPlayer` associated with the connected `MediaSession` seeks to the specified position.
`ListenableFuture<SessionResult>`	`selectTrack(SessionPlayer.TrackInfo trackInfo)` Requests that the `SessionPlayer` associated with the connected `MediaSession` selects the `SessionPlayer.TrackInfo` for the current media item.
`ListenableFuture<SessionResult>`	`sendCustomCommand(SessionCommand command, Bundle args)` Sends a custom command to the session Interoperability: When connected to `MediaSessionCompat`, `SessionResult.getResultCode()` will return the custom result code from the `ResultReceiver.onReceiveResult(int, Bundle)` instead of the standard result codes defined in the `SessionResult`.
`ListenableFuture<SessionResult>`	`setMediaItem(String mediaId)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets a `MediaItem` for playback.
`ListenableFuture<SessionResult>`	`setMediaUri(Uri uri, Bundle extras)` Requests that the connected `MediaSession` sets a specific `Uri` for playback.
`ListenableFuture<SessionResult>`	`setPlaybackSpeed(float playbackSpeed)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the playback speed.
`ListenableFuture<SessionResult>`	`setPlaylist(List<String> list, MediaMetadata metadata)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the playlist with the list of media IDs.
`ListenableFuture<SessionResult>`	`setRating(String mediaId, Rating rating)` Requests that the connected `MediaSession` rates the media.
`ListenableFuture<SessionResult>`	`setRepeatMode(int repeatMode)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the repeat mode.
`ListenableFuture<SessionResult>`	`setShuffleMode(int shuffleMode)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the shuffle mode.
`ListenableFuture<SessionResult>`	`setSurface(Surface surface)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the `Surface` to be used as the sink for the video portion of the media.
`ListenableFuture<SessionResult>`	`setVolumeTo(int value, int flags)` Requests that the connected `MediaSession` sets the volume of the output that is playing on.
`ListenableFuture<SessionResult>`	`skipBackward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips forward within the current media item.
`ListenableFuture<SessionResult>`	`skipForward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips backward within the current media item.
`ListenableFuture<SessionResult>`	`skipToNextPlaylistItem()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the next item in the playlist.
`ListenableFuture<SessionResult>`	`skipToPlaylistItem(int index)` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the item in the playlist at the index.
`ListenableFuture<SessionResult>`	`skipToPreviousPlaylistItem()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the previous item in the playlist.
`ListenableFuture<SessionResult>`	`updatePlaylistMetadata(MediaMetadata metadata)` Requests that the `SessionPlayer` associated with the connected `MediaSession` updates the playlist metadata while keeping the playlist as-is.

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

getChildren

public ListenableFuture<LibraryResult> getChildren (String parentId, 
                int page, 
                int pageSize, 
                MediaLibraryService.LibraryParams params)

Gets the list of children under the parent.

If it's successfully completed, LibraryResult.getMediaItems() will return the list of children.

Parameters
`parentId`	`String`: non-empty parent id for getting the children
`page`	`int`: page number to get the result. Starts from `0`
`pageSize`	`int`: page size. Should be greater than or equal to `1` Value is 1 or greater.
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`ListenableFuture<LibraryResult>`

See also:

LibraryResult.getMediaItems()

getItem

public ListenableFuture<LibraryResult> getItem (String mediaId)

Gets the media item with the given media id.

If it's successfully completed, LibraryResult.getMediaItem() will return the media item.

Parameters
`mediaId`	`String`: non-empty media id for specifying the item

Returns
`ListenableFuture<LibraryResult>`

See also:

LibraryResult.getMediaItem()

getLibraryRoot

public ListenableFuture<LibraryResult> getLibraryRoot (MediaLibraryService.LibraryParams params)

Gets the library root.

If it's successfully completed, LibraryResult.getMediaItem() will return the library root.

Parameters
`params`	`MediaLibraryService.LibraryParams`: library params getting root

Returns
`ListenableFuture<LibraryResult>`

See also:

LibraryResult.getMediaItem()

getSearchResult

public ListenableFuture<LibraryResult> getSearchResult (String query, 
                int page, 
                int pageSize, 
                MediaLibraryService.LibraryParams params)

Gets the search result from the library service.

If it's successfully completed, LibraryResult.getMediaItems() will return the search result.

Parameters
`query`	`String`: non-empty search query that you've specified with `search(String, LibraryParams)`.
`page`	`int`: page number to get search result. 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
`ListenableFuture<LibraryResult>`

See also:

LibraryResult.getMediaItems()

search

public ListenableFuture<LibraryResult> search (String query, 
                MediaLibraryService.LibraryParams params)

Sends a search request to the library service.

Returned LibraryResult will only tell whether the attempt to search was successful. For getting the search result, wait for MediaBrowser.BrowserCallback.onSearchResultChanged(MediaBrowser, String, int, LibraryParams) being called and call getSearchResult(String, int, int, LibraryParams)} for getting the result.

Parameters
`query`	`String`: non-empty search query
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`ListenableFuture<LibraryResult>`

See also:

public ListenableFuture<LibraryResult> subscribe (String parentId, 
                MediaLibraryService.LibraryParams params)

Subscribes to a parent id for the change in its children. When there's a change, MediaBrowser.BrowserCallback.onChildrenChanged(MediaBrowser, String, int, LibraryParams) will be called with the library params. You should call getChildren(String, int, int, LibraryParams) to get the items under the parent.

Parameters
`parentId`	`String`: non-empty parent id
`params`	`MediaLibraryService.LibraryParams`: library params

Returns
`ListenableFuture<LibraryResult>`

unsubscribe

public ListenableFuture<LibraryResult> unsubscribe (String parentId)

Unsubscribes for changes to the children of the parent, which was previously subscribed with subscribe(String, LibraryParams).

This unsubscribes all previous subscriptions with the parent id, regardless of the library param that was previously sent to the library service.

Parameters
`parentId`	`String`: non-empty parent id

Returns
`ListenableFuture<LibraryResult>`

MediaBrowser

Summary

Nested classes

Public methods

Inherited methods

Public methods

getChildren

getItem

getLibraryRoot

getSearchResult

search

subscribe

unsubscribe