Summary: Nested Classes | Ctors | Methods | Inherited Methods

MediaBrowser2

public class MediaBrowser2
extends MediaController2

java.lang.Object
↳	androidx.media2.MediaController2
	↳	androidx.media2.MediaBrowser2

Browses media content offered by a MediaLibraryService2.

Summary

Nested classes
`class`	`MediaBrowser2.BrowserCallback` Callback to listen events from `MediaLibraryService2`.

Public constructors
`MediaBrowser2(Context context, SessionToken2 token, Executor executor, MediaBrowser2.BrowserCallback callback)`

Public methods
`void`	`getChildren(String parentId, int page, int pageSize, Bundle extras)` Get list of children under the parent.
`void`	`getItem(String mediaId)` Get the media item with the given media id.
`void`	`getLibraryRoot(Bundle extras)` Get the library root.
`void`	`getSearchResult(String query, int page, int pageSize, Bundle extras)` Get the search result from lhe library service.
`void`	`search(String query, Bundle extras)` Send a search request to the library service.
`void`	`subscribe(String parentId, Bundle extras)` Subscribe to a parent id for the change in its children.
`void`	`unsubscribe(String parentId)` Unsubscribe for changes to the children of the parent, which was previously subscribed with `subscribe(String, Bundle)`.

Inherited methods

From class


        
          androidx.media2.MediaController2

`void`	`addPlaylistItem(int index, MediaItem2 item)` Adds the media item to the playlist at position index.
`void`	`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.
`void`	`fastForward()` Start fast forwarding.
`long`	`getBufferedPosition()` Gets the lastly cached buffered position from the session when `MediaController2.ControllerCallback.onBufferingStateChanged(MediaController2, MediaItem2, int)` is called.
`int`	`getBufferingState()` Gets the current buffering state of the player.
`MediaItem2`	`getCurrentMediaItem()` Get the lastly cached current item from `MediaController2.ControllerCallback.onCurrentMediaItemChanged(MediaController2, MediaItem2)`.
`long`	`getCurrentPosition()` Gets the current playback position.
`long`	`getDuration()` Gets the duration of the current media item, or `MediaPlayerConnector.UNKNOWN_TIME` if unknown.
`MediaController2.PlaybackInfo`	`getPlaybackInfo()` Get the current playback info for this session.
`float`	`getPlaybackSpeed()` Get the lastly cached playback speed from `MediaController2.ControllerCallback.onPlaybackSpeedChanged(MediaController2, float)`.
`int`	`getPlayerState()` Get the lastly cached player state from `MediaController2.ControllerCallback.onPlayerStateChanged(MediaController2, int)`.
`List<MediaItem2>`	`getPlaylist()` Returns the cached playlist from `MediaController2.ControllerCallback.onPlaylistChanged(MediaController2, List, MediaMetadata2)`.
`MediaMetadata2`	`getPlaylistMetadata()` Gets the lastly cached playlist playlist metadata either from {@link ControllerCallback#onPlaylistMetadataChanged or {@link ControllerCallback#onPlaylistChanged}.
`int`	`getRepeatMode()` Gets the cached repeat mode from the `MediaController2.ControllerCallback.onRepeatModeChanged(MediaController2, int)`.
`PendingIntent`	`getSessionActivity()` Get an intent for launching UI associated with this session if one exists.
`SessionToken2`	`getSessionToken()`
`int`	`getShuffleMode()` Gets the cached shuffle mode from the `MediaController2.ControllerCallback.onShuffleModeChanged(MediaController2, int)`.
`boolean`	`isConnected()` Returns whether this class is connected to active `MediaSession2` or not.
`void`	`pause()` Requests that the player pauses playback.
`void`	`play()` Requests that the player starts or resumes playback.
`void`	`playFromMediaId(String mediaId, Bundle extras)` Request that the player start playback for a specific media id.
`void`	`playFromSearch(String query, Bundle extras)` Request that the player start playback for a specific search query.
`void`	`playFromUri(Uri uri, Bundle extras)` Request that the player start playback for a specific `Uri`.
`void`	`prepare()` Request that the player prepare its playback.
`void`	`prepareFromMediaId(String mediaId, Bundle extras)` Request that the player prepare playback for a specific media id.
`void`	`prepareFromSearch(String query, Bundle extras)` Request that the player prepare playback for a specific search query.
`void`	`prepareFromUri(Uri uri, Bundle extras)` Request that the player prepare playback for a specific `Uri`.
`void`	`removePlaylistItem(MediaItem2 item)` Removes the media item at index in the playlist.
`void`	`replacePlaylistItem(int index, MediaItem2 item)` Replace the media item at index in the playlist.
`void`	`reset()` Requests that the player be reset to its uninitialized state.
`void`	`rewind()` Start rewinding.
`void`	`seekTo(long pos)` Move to a new location in the media stream.
`void`	`selectRoute(Bundle route)` Selects the specified route.
`void`	`sendCustomCommand(SessionCommand2 command, Bundle args, ResultReceiver cb)` Send custom command to the session
`void`	`setPlaybackSpeed(float speed)` Set the playback speed.
`void`	`setPlaylist(List<MediaItem2> list, MediaMetadata2 metadata)` Sets the playlist.
`void`	`setRating(String mediaId, Rating2 rating)` Rate the media.
`void`	`setRepeatMode(int repeatMode)` Sets the repeat mode.
`void`	`setShuffleMode(int shuffleMode)` Sets the shuffle mode.
`void`	`setVolumeTo(int value, int flags)` Set the volume of the output this session is playing on.
`void`	`skipToNextItem()` Skips to the next item in the playlist.
`void`	`skipToPlaylistItem(MediaItem2 item)` Skips to the item in the playlist.
`void`	`skipToPreviousItem()` Skips to the previous item in the playlist.
`void`	`subscribeRoutesInfo()` Queries for information about the routes currently known.
`void`	`unsubscribeRoutesInfo()` Unsubscribes for changes to the routes.
`void`	`updatePlaylistMetadata(MediaMetadata2 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 constructors

MediaBrowser2

public MediaBrowser2 (Context context, 
                SessionToken2 token, 
                Executor executor, 
                MediaBrowser2.BrowserCallback callback)

Parameters
`context`	`Context`
`token`	`SessionToken2`
`executor`	`Executor`
`callback`	`MediaBrowser2.BrowserCallback`

Public methods

getChildren

public void getChildren (String parentId, 
                int page, 
                int pageSize, 
                Bundle extras)

Get list of children under the parent. Result would be sent back asynchronously with the MediaBrowser2.BrowserCallback.onGetChildrenDone(MediaBrowser2, String, int, int, List, Bundle).

Parameters
`parentId`	`String`: 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`
`extras`	`Bundle`: extra bundle

getItem

public void getItem (String mediaId)

Get the media item with the given media id. Result would be sent back asynchronously with the MediaBrowser2.BrowserCallback.onGetItemDone(MediaBrowser2, String, MediaItem2).

Parameters
`mediaId`	`String`: media id for specifying the item

getLibraryRoot

public void getLibraryRoot (Bundle extras)

Get the library root. Result would be sent back asynchronously with the MediaBrowser2.BrowserCallback.onGetLibraryRootDone(MediaBrowser2, Bundle, String, Bundle).

Parameters
`extras`	`Bundle`: extras for getting root

See also:

MediaBrowser2.BrowserCallback.onGetLibraryRootDone(MediaBrowser2, Bundle, String, Bundle)

getSearchResult

public void getSearchResult (String query, 
                int page, 
                int pageSize, 
                Bundle extras)

Get the search result from lhe library service. Result would be sent back asynchronously with the MediaBrowser2.BrowserCallback.onGetSearchResultDone(MediaBrowser2, String, int, int, List, Bundle).

Parameters
`query`	`String`: search query that you've specified with `search(String, Bundle)`
`page`	`int`: page number to get search result. Starts from `0`
`pageSize`	`int`: page size. Should be greater or equal to `1`
`extras`	`Bundle`: extra bundle

search

public void search (String query, 
                Bundle extras)

Send a search request to the library service. When the search result is changed, MediaBrowser2.BrowserCallback.onSearchResultChanged(MediaBrowser2, String, int, Bundle) will be called. You should call getSearchResult(String, int, int, Bundle) to get the actual search result.

Parameters
`query`	`String`: search query. Should not be an empty string.
`extras`	`Bundle`: extra bundle

public void subscribe (String parentId, 
                Bundle extras)

Subscribe to a parent id for the change in its children. When there's a change, MediaBrowser2.BrowserCallback.onChildrenChanged(MediaBrowser2, String, int, Bundle) will be called with the bundle that you've specified. You should call getChildren(String, int, int, Bundle) to get the actual contents for the parent.

Parameters
`parentId`	`String`: parent id
`extras`	`Bundle`: extra bundle

unsubscribe

public void unsubscribe (String parentId)

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

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

Parameters
`parentId`	`String`: parent id

MediaBrowser2

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

MediaBrowser2

Public methods

getChildren

getItem

getLibraryRoot

getSearchResult

search

unsubscribe

Interfaces

Classes

Exceptions