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 lhe 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)` Adds the media item to the playlist at the index with the media ID.
`ListenableFuture<SessionResult>`	`adjustVolume(int direction, int flags)` Adjust the volume of the output this session is playing on.
`void`	`close()` Release this object, and disconnect from the session.
`ListenableFuture<SessionResult>`	`fastForward()` Requests session to increase the playback speed.
`long`	`getBufferedPosition()` Gets the lastly cached buffered position from the session when `MediaController.ControllerCallback.onBufferingStateChanged(MediaController, MediaItem, int)` is called.
`int`	`getBufferingState()` Gets the current buffering state of the player.
`SessionToken`	`getConnectedToken()` Returns `SessionToken` of the connected session.
`MediaItem`	`getCurrentMediaItem()` Gets the lastly cached current item from `MediaController.ControllerCallback.onCurrentMediaItemChanged(MediaController, MediaItem)`.
`int`	`getCurrentMediaItemIndex()` Gets the current item index in the playlist.
`long`	`getCurrentPosition()` Gets the current playback position.
`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.
`MediaController.PlaybackInfo`	`getPlaybackInfo()` Get the current playback info for this session.
`float`	`getPlaybackSpeed()` Get the lastly cached playback speed from `MediaController.ControllerCallback.onPlaybackSpeedChanged(MediaController, float)`.
`int`	`getPlayerState()` Get the lastly cached player state from `MediaController.ControllerCallback.onPlayerStateChanged(MediaController, int)`.
`List<MediaItem>`	`getPlaylist()` Returns the cached playlist from `MediaController.ControllerCallback.onPlaylistChanged(MediaController, List, MediaMetadata)`.
`MediaMetadata`	`getPlaylistMetadata()` Gets the lastly cached playlist metadata either from `MediaController.ControllerCallback.onPlaylistMetadataChanged(MediaController, MediaMetadata)` or `MediaController.ControllerCallback.onPlaylistChanged(MediaController, List, MediaMetadata)`.
`int`	`getPreviousMediaItemIndex()` Gets the previous item index in the playlist.
`int`	`getRepeatMode()` Gets the cached repeat mode from the `MediaController.ControllerCallback.onRepeatModeChanged(MediaController, int)`.
`PendingIntent`	`getSessionActivity()` Get an intent for launching UI associated with this session if one exists.
`int`	`getShuffleMode()` Gets the cached shuffle mode from the `MediaController.ControllerCallback.onShuffleModeChanged(MediaController, int)`.
`boolean`	`isConnected()` Returns whether this class is connected to active `MediaSession` or not.
`ListenableFuture<SessionResult>`	`pause()` Requests that the player pauses playback.
`ListenableFuture<SessionResult>`	`play()` Requests that the player starts or resumes playback.
`ListenableFuture<SessionResult>`	`prepare()` Requests that the player prepares the media items for playback.
`ListenableFuture<SessionResult>`	`removePlaylistItem(int index)` Removes the media item at index in the playlist.
`ListenableFuture<SessionResult>`	`replacePlaylistItem(int index, String mediaId)` Replaces the media item at index in the playlist with the media ID.
`ListenableFuture<SessionResult>`	`rewind()` Requests session to decrease the playback speed.
`ListenableFuture<SessionResult>`	`seekTo(long pos)` Move to a new location in the media stream.
`ListenableFuture<SessionResult>`	`sendCustomCommand(SessionCommand command, Bundle args)` Send 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)` Sets a `MediaItem` for playback with the media ID.
`ListenableFuture<SessionResult>`	`setPlaybackSpeed(float speed)` Sets the playback speed.
`ListenableFuture<SessionResult>`	`setPlaylist(List<String> list, MediaMetadata metadata)` Sets the playlist with the list of media IDs.
`ListenableFuture<SessionResult>`	`setRating(String mediaId, Rating rating)` Rate the media.
`ListenableFuture<SessionResult>`	`setRepeatMode(int repeatMode)` Sets the repeat mode.
`ListenableFuture<SessionResult>`	`setShuffleMode(int shuffleMode)` Sets the shuffle mode.
`ListenableFuture<SessionResult>`	`setVolumeTo(int value, int flags)` Set the volume of the output this session is playing on.
`ListenableFuture<SessionResult>`	`skipBackward()` Requests session to skip forward within the current media item.
`ListenableFuture<SessionResult>`	`skipForward()` Requests session to skip backward within the current media item.
`ListenableFuture<SessionResult>`	`skipToNextPlaylistItem()` Skips to the next item in the playlist.
`ListenableFuture<SessionResult>`	`skipToPlaylistItem(int index)` Skips to the item in the playlist at the index.
`ListenableFuture<SessionResult>`	`skipToPreviousPlaylistItem()` Skips to the previous item in the playlist.
`ListenableFuture<SessionResult>`	`updatePlaylistMetadata(MediaMetadata metadata)` Updates the playlist metadata

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.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 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 lhe 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 attemp to search was successful. For getting the search result, waits for getSearchResult(String, int, int, LibraryParams) the search result and calls 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 subscription 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>`

Classes

MediaBrowser

Summary

Nested classes

Public methods

Inherited methods

Public methods

getChildren

getItem

getLibraryRoot

getSearchResult

search

subscribe

unsubscribe

Classes