MediaBrowser

Kotlin |Java

open class MediaBrowser : MediaController

kotlin.Any
↳	androidx.media2.session.MediaController
	↳	androidx.media2.session.MediaBrowser

Browses media content offered by a MediaLibraryService.

Summary

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

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

Inherited functions

From class MediaController

`ListenableFuture<SessionResult!>`	`addPlaylistItem(@IntRange(0) index: Int, @NonNull mediaId: String)` Requests that the `SessionPlayer` associated with the connected `MediaSession` adds the media item to the playlist at the index with the media ID. Index equals to or greater than the current playlist size (e.g. `Integer#MAX_VALUE`) will add the item at the end of the playlist. If index is less than or equal to the current index of the playlist, the current index of the playlist will be increased correspondingly. On success, a `SessionResult` would be returned with `item` added.
`ListenableFuture<SessionResult!>`	`adjustVolume(direction: Int, flags: Int)` Requests that the connected `MediaSession` adjusts the volume of the output that is playing on. The direction must be one of `AudioManager#ADJUST_LOWER`, `AudioManager#ADJUST_RAISE`, or `AudioManager#ADJUST_SAME`. The command will be ignored if the session does not support `VolumeProviderCompat#VOLUME_CONTROL_RELATIVE` or `VolumeProviderCompat#VOLUME_CONTROL_ABSOLUTE`. If the session is local playback, this changes the device's volume with the stream that session's player is using. Flags will be specified for the `AudioManager`. If the session is remote player (i.e. session has set volume provider), its volume provider will receive this request instead.
`Unit`	`close()` Releases this object, and disconnects from the session. After this, callbacks wouldn't be received.
`ListenableFuture<SessionResult!>`	`deselectTrack(@NonNull trackInfo: SessionPlayer.TrackInfo)` Requests that the `SessionPlayer` associated with the connected `MediaSession` deselects the `TrackInfo` for the current media item. Generally, a track should already be selected in order to be deselected and audio and video tracks should not be deselected. The types of tracks supported may vary based on players. Note: `getSelectedTrack(int)` returns the currently selected track per track type that can be deselected, but the list may be invalidated when `ControllerCallback#onTracksChanged(MediaController, List)` is called.
`ListenableFuture<SessionResult!>`	`fastForward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` to fast forward playback. The implementation may be different depending on the players. For example, it can be implemented by seeking forward once, series of seeking forward, or increasing playback speed. If you need full control, then use `seekTo` or `setPlaybackSpeed` directly.
`SessionCommandGroup?`	`getAllowedCommands()` Gets the cached allowed commands from `ControllerCallback#onAllowedCommandsChanged`. If it is not connected yet, it returns `null`.
`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`. The position is the relative position based on the `MediaItem#getStartPosition()`. So the position `0` means the start position of the `MediaItem`.
`SessionToken?`	`getConnectedToken()` Returns the `SessionToken` of the connected session. If it is not connected yet, it returns `null`. This may differ from the `SessionToken` from the constructor. For example, if the controller is created with the token for `MediaSessionService`, this would return token for the `MediaSession` in the service.
`MediaItem?`	`getCurrentMediaItem()` Gets the current media item of the `SessionPlayer` associated with the connected `MediaSession`. This can be currently playing or would be played with later `play`. This value may be updated when `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)` or `ControllerCallback#onPlaylistChanged(MediaController, List, MediaMetadata)` is called.
`Int`	`getCurrentMediaItemIndex()` Gets the current item index in the playlist of the `SessionPlayer` associated with the connected `MediaSession`. The value would be updated when `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)` or `ControllerCallback#onPlaylistChanged(MediaController, List, MediaMetadata)` is called.
`Long`	`getCurrentPosition()` Gets the playback position of the `SessionPlayer` associated with the connected `MediaSession`. The position is the relative position based on the `MediaItem#getStartPosition()`. So the position `0` means the start position of the `MediaItem`.
`Long`	`getDuration()` Gets the duration of the current media item, or `SessionPlayer#UNKNOWN_TIME` if unknown or not connected. If the current `MediaItem` has either start or end position, then duration would be adjusted accordingly instead of returning the whole size of the `MediaItem`.
`Int`	`getNextMediaItemIndex()` Gets the next item index in the playlist of the `SessionPlayer` associated with the connected `MediaSession`. This value would be updated when `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)` or `ControllerCallback#onPlaylistChanged(MediaController, List, MediaMetadata)` is called. Interoperability: When connected to `android.support.v4.media.session.MediaSessionCompat`, this will always return `SessionPlayer#INVALID_ITEM_INDEX`..
`MediaController.PlaybackInfo?`	`getPlaybackInfo()` Get the current playback info for this session. If it is not connected yet, it returns `null`.
`Float`	`getPlaybackSpeed()` Gets the playback speed to be used by the of the `SessionPlayer` associated with the connected `MediaSession` when playing. A value of `1.0f` is the default playback value, and a negative value indicates reverse playback. Note that it may differ from the speed set in `setPlaybackSpeed(float)`.
`Int`	`getPlayerState()` Gets the state of the `SessionPlayer` associated with the connected `MediaSession`. If it is not connected yet, it returns `SessionPlayer#PLAYER_STATE_IDLE`.
`MutableList<MediaItem!>?`	`getPlaylist()` Gets the playlist of the `SessionPlayer` associated with the connected `MediaSession`. It can be `null` if the playlist hasn't been set or it's reset by `setMediaItem`. This list may differ from the list that was specified with `setPlaylist(List, MediaMetadata)` depending on the `SessionPlayer` implementation.
`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`. This value would be updated when `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)` or `ControllerCallback#onPlaylistChanged(MediaController, List, MediaMetadata)` is called. Interoperability: When connected to `android.support.v4.media.session.MediaSessionCompat`, this will always return `SessionPlayer#INVALID_ITEM_INDEX`.
`Int`	`getRepeatMode()` Gets the repeat mode of the `SessionPlayer` associated with the connected `MediaSession`. If it is not connected yet, it returns `SessionPlayer#REPEAT_MODE_NONE`.
`SessionPlayer.TrackInfo?`	`getSelectedTrack(trackType: Int)` Gets the currently selected track for the given track type of the `SessionPlayer` associated with the connected `MediaSession`. If it is not connected yet, it returns `null`. The returned value can be outdated after `ControllerCallback#onTracksChanged(MediaController, List)`, `ControllerCallback#onTrackSelected(MediaController, TrackInfo)`, or `ControllerCallback#onTrackDeselected(MediaController, TrackInfo)` is called.
`PendingIntent?`	`getSessionActivity()` Gets an intent for launching UI associated with this session if one exists. If it is not connected yet, it returns `null`.
`Int`	`getShuffleMode()` Gets the shuffle mode of the `SessionPlayer` associated with the connected `MediaSession`. If it is not connected yet, it returns `SessionPlayer#SHUFFLE_MODE_NONE`.
`MutableList<SessionPlayer.TrackInfo!>`	`getTracks()` Gets the full list of selected and unselected tracks that the media contains of the `SessionPlayer` associated with the connected `MediaSession`. The order of the list is irrelevant as different players expose tracks in different ways, but the tracks will generally be ordered based on track type. The types of tracks supported may vary based on player implementation.
`VideoSize`	`getVideoSize()` Gets the video size of the `SessionPlayer` associated with the connected `MediaSession`. If it is not connected yet, it returns `new VideoSize(0, 0)`.
`Boolean`	`isConnected()` Returns whether this class is connected to active `MediaSession` or not.
`ListenableFuture<SessionResult!>`	`movePlaylistItem(@IntRange(0) fromIndex: Int, @IntRange(0) toIndex: Int)` Requests that the `SessionPlayer` associated with the connected `MediaSession` moves the media item at `fromIdx` to `toIdx` in the playlist. On success, a `SessionResult` would be returned with `item` set.
`ListenableFuture<SessionResult!>`	`pause()` Requests that the `SessionPlayer` associated with the connected `MediaSession` pauses playback. On success, this transfers the player state to `SessionPlayer#PLAYER_STATE_PAUSED` and a `SessionResult` would be returned with the current media item when the command was completed. If it is called in `SessionPlayer#PLAYER_STATE_IDLE` or `SessionPlayer#PLAYER_STATE_ERROR`, it whould be ignored and a `SessionResult` would be returned with `SessionResult#RESULT_ERROR_INVALID_STATE`.
`ListenableFuture<SessionResult!>`	`play()` Requests that the `SessionPlayer` associated with the connected `MediaSession` starts or resumes playback. On success, this transfers the player state to `SessionPlayer#PLAYER_STATE_PLAYING` and a `SessionResult` would be returned with the current media item when the command was completed. If the player state is `SessionPlayer#PLAYER_STATE_IDLE`, the session would also call `SessionPlayer#prepare` and then `SessionPlayer#play` to start playback. If you want to have finer grained control of the playback start, call `prepare` manually before this. Calling `prepare` in advance would help this method to start playback faster and also help to take audio focus at the last moment.
`ListenableFuture<SessionResult!>`	`prepare()` Requests that the `SessionPlayer` associated with the connected `MediaSession` prepares the media items for playback. During this time, the player may allocate resources required to play, such as audio and video decoders. Before calling this API, sets media item(s) through either `setMediaItem` or `setPlaylist`. On success, this transfers the player state from `SessionPlayer#PLAYER_STATE_IDLE` to `SessionPlayer#PLAYER_STATE_PAUSED` and a `SessionResult` would be returned with the prepared media item when the command completed. If it's not called in `SessionPlayer#PLAYER_STATE_IDLE`, it would be ignored and `SessionResult` would be returned with `SessionResult#RESULT_ERROR_INVALID_STATE`. Playback can be started without this. But this provides finer grained control of playback start. See `play` for details.
`ListenableFuture<SessionResult!>`	`removePlaylistItem(@IntRange(0) index: Int)` Requests that the `SessionPlayer` associated with the connected `MediaSession` removes the media item at index in the playlist. On success, a `SessionResult` would be returned with `item` removed.
`ListenableFuture<SessionResult!>`	`replacePlaylistItem(@IntRange(0) index: Int, @NonNull mediaId: String)` Requests that the `SessionPlayer` associated with the connected `MediaSession` replaces the media item at index in the playlist with the media ID. On success, a `SessionResult` would be returned with `item` set.
`ListenableFuture<SessionResult!>`	`rewind()` Requests that the `SessionPlayer` associated with the connected `MediaSession` to rewind playback. The implementation may be different depending on the players. For example, it can be implemented by seeking backward once, series of seeking backward, or decreasing playback speed. If you need full control, then use `seekTo` or `setPlaybackSpeed` directly.
`ListenableFuture<SessionResult!>`	`seekTo(position: Long)` Requests that the `SessionPlayer` associated with the connected `MediaSession` seeks to the specified position. The position is the relative position based on the `MediaItem#getStartPosition()`. So calling `seekTo(long)` with `0` means the seek to the start position. On success, a `SessionResult` would be returned with the current media item when the command completed. If it's called in `SessionPlayer#PLAYER_STATE_IDLE`, it is ignored and a `SessionResult` would be returned with `SessionResult#RESULT_ERROR_INVALID_STATE`.
`ListenableFuture<SessionResult!>`	`selectTrack(@NonNull trackInfo: SessionPlayer.TrackInfo)` Requests that the `SessionPlayer` associated with the connected `MediaSession` selects the `TrackInfo` for the current media item. Generally one track will be selected for each track type. The types of tracks supported may vary based on players. Note: `getTracks()` returns the list of tracks that can be selected, but the list may be invalidated when `ControllerCallback#onTracksChanged(MediaController, List)` is called.
`ListenableFuture<SessionResult!>`	`sendCustomCommand(@NonNull command: SessionCommand, @Nullable args: Bundle?)` Sends a custom command to the session Interoperability: When connected to `android.support.v4.media.session.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`. A command is not accepted if it is not a custom command.
`ListenableFuture<SessionResult!>`	`setMediaItem(@NonNull mediaId: String)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets a `MediaItem` for playback. Use this, `setMediaUri`, or `setPlaylist` to specify which items to play. If you want to change current item in the playlist, use one of `skipToPlaylistItem`, `skipToNextPlaylistItem`, or `skipToPreviousPlaylistItem` instead of this method. This can be called multiple times in any states other than `SessionPlayer#PLAYER_STATE_ERROR`. This would override previous call of this, `setMediaUri`, or `setPlaylist`. The `ControllerCallback#onPlaylistChanged` and/or `ControllerCallback#onCurrentMediaItemChanged` would be called when it's completed. On success, a `SessionResult` would be returned with `item` set.
`ListenableFuture<SessionResult!>`	`setMediaUri(@NonNull uri: Uri, @Nullable extras: Bundle?)` Requests that the connected `MediaSession` sets a specific `Uri` for playback. Use this, `setMediaItem`, or `setPlaylist` to specify which items to play. This can be called multiple times in any states other than `SessionPlayer#PLAYER_STATE_ERROR`. This would override previous call of this, `setMediaItem`, or `setPlaylist`. The `ControllerCallback#onPlaylistChanged` and/or `ControllerCallback#onCurrentMediaItemChanged` would be called when it's completed. On success, a `SessionResult` would be returned with `item` set.
`ListenableFuture<SessionResult!>`	`setPlaybackSpeed(playbackSpeed: Float)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the playback speed. The default playback speed is `1.0f` is the default, and negative values indicate reverse playback and `0.0f` is not allowed. The supported playback speed range depends on the player, so it is recommended to query the actual speed of the player via `getPlaybackSpeed()` after the operation completes. In particular, please note that the player may not support reverse playback. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`setPlaylist(@NonNull list: MutableList<String!>, @Nullable metadata: MediaMetadata?)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the playlist with the list of media IDs. Use this, `setMediaUri`, or `setMediaItem` to specify which items to play. All media IDs in the list shouldn't be an empty string. This can be called multiple times in any states other than `SessionPlayer#PLAYER_STATE_ERROR`. This would override previous call of this, `setMediaItem`, or `setMediaUri`. The `ControllerCallback#onPlaylistChanged` and/or `ControllerCallback#onCurrentMediaItemChanged` would be called when it's completed. The current item would be the first item in the playlist.
`ListenableFuture<SessionResult!>`	`setRating(@NonNull mediaId: String, @NonNull rating: Rating)` Requests that the connected `MediaSession` rates the media. This will cause the rating to be set for the current user. The rating style must follow the user rating style from the session.You can get the rating style from the session through the `MediaMetadata#getRating(String)` with the key `MediaMetadata#METADATA_KEY_USER_RATING`. If the user rating was `null`, the media item does not accept setting user rating.
`ListenableFuture<SessionResult!>`	`setRepeatMode(repeatMode: Int)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the repeat mode. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`setShuffleMode(shuffleMode: Int)` Requests that the `SessionPlayer` associated with the connected `MediaSession` sets the shuffle mode. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`setSurface(@Nullable 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. A null surface will reset any Surface and result in only the audio track being played. On success, a `SessionResult` is returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`setVolumeTo(value: Int, flags: Int)` Requests that the connected `MediaSession` sets the volume of the output that is playing on. The command will be ignored if it does not support `VolumeProviderCompat#VOLUME_CONTROL_ABSOLUTE`. If the session is local playback, this changes the device's volume with the stream that session's player is using. Flags will be specified for the `AudioManager`. If the session is remote player (i.e. session has set volume provider), its volume provider will receive this request instead.
`ListenableFuture<SessionResult!>`	`skipBackward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips forward within the current media item. The implementation may be different depending on the players. For example, it can be implemented by seeking backward once with the fixed amount of seconds, or seeking backward to the nearest bookmark. If you need full control, then use `seekTo` directly.
`ListenableFuture<SessionResult!>`	`skipForward()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips backward within the current media item. The implementation may be different depending on the players. For example, it can be implemented by seeking forward once with the fixed amount of seconds, or seeking forward to the nearest bookmark. If you need full control, then use `seekTo` directly.
`ListenableFuture<SessionResult!>`	`skipToNextPlaylistItem()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the next item in the playlist. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`skipToPlaylistItem(@IntRange(0) index: Int)` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the item in the playlist at the index. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`skipToPreviousPlaylistItem()` Requests that the `SessionPlayer` associated with the connected `MediaSession` skips to the previous item in the playlist. On success, a `SessionResult` would be returned with the current media item when the command completed.
`ListenableFuture<SessionResult!>`	`updatePlaylistMetadata(@Nullable metadata: MediaMetadata?)` Requests that the `SessionPlayer` associated with the connected `MediaSession` updates the playlist metadata while keeping the playlist as-is. On success, a `SessionResult` would be returned with the current media item when the command completed.

Public methods

getChildren

@NonNull open fun getChildren(
    @NonNull parentId: String, 
    @IntRange(0) page: Int, 
    @IntRange(1) pageSize: Int, 
    @Nullable params: MediaLibraryService.LibraryParams?
): ListenableFuture<LibraryResult!>

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`
`params`	MediaLibraryService.LibraryParams?: library params

See Also

LibraryResult#getMediaItems()

getItem

@NonNull open fun getItem(@NonNull mediaId: String): ListenableFuture<LibraryResult!>

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

See Also

LibraryResult#getMediaItem()

getLibraryRoot

@NonNull open fun getLibraryRoot(@Nullable params: MediaLibraryService.LibraryParams?): ListenableFuture<LibraryResult!>

Gets the library root.

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

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

See Also

LibraryResult#getMediaItem()

getSearchResult

@NonNull open fun getSearchResult(
    @NonNull query: String, 
    @IntRange(0) page: Int, 
    @IntRange(1) pageSize: Int, 
    @Nullable params: MediaLibraryService.LibraryParams?
): ListenableFuture<LibraryResult!>

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`
`params`	MediaLibraryService.LibraryParams?: library params

See Also

LibraryResult#getMediaItems()

search

@NonNull open fun search(
    @NonNull query: String, 
    @Nullable params: MediaLibraryService.LibraryParams?
): ListenableFuture<LibraryResult!>

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 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

See Also

@NonNull open fun subscribe(
    @NonNull parentId: String, 
    @Nullable params: MediaLibraryService.LibraryParams?
): ListenableFuture<LibraryResult!>

Subscribes to a parent id for the change in its children. When there's a change, 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

unsubscribe

@NonNull open fun unsubscribe(@NonNull parentId: String): ListenableFuture<LibraryResult!>

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

MediaBrowser

Summary

Nested classes

Public methods

Inherited functions

Public methods

getChildren

getItem

getLibraryRoot

getSearchResult

search

subscribe

unsubscribe