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, page: Int, 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, page: Int, pageSize: Int, @Nullable params: MediaLibraryService.LibraryParams?)` Gets the search result from lhe 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(index: Int, @NonNull mediaId: String)` Adds the media item to the playlist at the index with the media ID. Index equals or greater than the current playlist size (e.g. `Integer#MAX_VALUE`) will add the item at the end of the playlist. This will not change the currently playing media item. If index is less than or equal to the current index of the playlist, the current index of the playlist will be incremented correspondingly.
`ListenableFuture<SessionResult!>`	`adjustVolume(direction: Int, flags: Int)` Adjust the volume of the output this session 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()` Release this object, and disconnect from the session. After this, callbacks wouldn't be received.
`ListenableFuture<SessionResult!>`	`fastForward()` Requests session to increase the playback speed.
`Long`	`getBufferedPosition()` Gets the lastly cached buffered position from the session when `ControllerCallback#onBufferingStateChanged(MediaController, MediaItem, int)` is called.
`Int`	`getBufferingState()` Gets the current buffering state of the player. During buffering, see `getBufferedPosition()` for the quantifying the amount already buffered.
`SessionToken?`	`getConnectedToken()` Returns `SessionToken` of the connected session. If it is not connected yet, it returns `null`. This may differ with 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 lastly cached current item from `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)`.
`Int`	`getCurrentMediaItemIndex()` Gets the current item index in the playlist. The returned value can be outdated after `ControllerCallback#onCurrentMediaItemChanged(MediaController, MediaItem)` or `ControllerCallback#onPlaylistChanged(MediaController, List, MediaMetadata)` is called.
`Long`	`getCurrentPosition()` Gets the current playback position. This returns the calculated value of the position, based on the difference between the update time and current time.
`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. The returned value can be outdated after `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 `-1`.
`MediaController.PlaybackInfo?`	`getPlaybackInfo()` Get the current playback info for this session. If it is not connected yet, it returns `null`.
`Float`	`getPlaybackSpeed()` Get the lastly cached playback speed from `ControllerCallback#onPlaybackSpeedChanged(MediaController, float)`.
`Int`	`getPlayerState()` Get the lastly cached player state from `ControllerCallback#onPlayerStateChanged(MediaController, int)`. If it is not connected yet, it returns `SessionPlayer#PLAYER_STATE_IDLE`.
`MutableList<MediaItem!>?`	`getPlaylist()` Returns the cached playlist from `ControllerCallback#onPlaylistChanged`. Can be `null` if the playlist hasn't been set or it's reset by `setMediaItem`. This list may differ with the list that was specified with `setPlaylist(List, MediaMetadata)` depending on the `SessionPlayer` implementation. Use media items returned here for other playlist agent APIs such as `SessionPlayer#skipToPlaylistItem`.
`MediaMetadata?`	`getPlaylistMetadata()` Gets the lastly cached playlist metadata either from `ControllerCallback#onPlaylistMetadataChanged` or `ControllerCallback#onPlaylistChanged`.
`Int`	`getPreviousMediaItemIndex()` Gets the previous item index in the playlist. The returned value can be outdated after `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 `-1`.
`Int`	`getRepeatMode()` Gets the cached repeat mode from the `ControllerCallback#onRepeatModeChanged`. If it is not connected yet, it returns `SessionPlayer#REPEAT_MODE_NONE`.
`PendingIntent?`	`getSessionActivity()` Get 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 cached shuffle mode from the `ControllerCallback#onShuffleModeChanged`. If it is not connected yet, it returns `SessionPlayer#SHUFFLE_MODE_NONE`.
`Boolean`	`isConnected()` Returns whether this class is connected to active `MediaSession` or not.
`ListenableFuture<SessionResult!>`	`pause()` Requests that the player pauses playback. This would transfer the player state from `SessionPlayer#PLAYER_STATE_PLAYING` to `SessionPlayer#PLAYER_STATE_PAUSED`.
`ListenableFuture<SessionResult!>`	`play()` Requests that the player starts or resumes playback. 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 player prepares the media items for playback. This would transfer the player state from `SessionPlayer#PLAYER_STATE_IDLE` to `SessionPlayer#PLAYER_STATE_PAUSED`. Playback can be started without this. But this provides finer grained control of playback start. See `play` for details.
`ListenableFuture<SessionResult!>`	`removePlaylistItem(index: Int)` Removes the media item at index in the playlist. If the item is the currently playing item of the playlist, current playback will be stopped and playback moves to next source in the list.
`ListenableFuture<SessionResult!>`	`replacePlaylistItem(index: Int, @NonNull mediaId: String)` 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(pos: Long)` Move to a new location in the media stream.
`ListenableFuture<SessionResult!>`	`sendCustomCommand(@NonNull command: SessionCommand, @Nullable args: Bundle?)` Send 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)` Sets a `MediaItem` for playback with the media ID. Use this 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. The `ControllerCallback#onPlaylistChanged` and `ControllerCallback#onCurrentMediaItemChanged` would be called when it's completed. The current item would be the item given here.
`ListenableFuture<SessionResult!>`	`setPlaybackSpeed(speed: Float)` Sets the playback speed. A value of `1.0f` is the default playback value, and a negative value indicates reverse playback. `0.0f` is not allowed.
`ListenableFuture<SessionResult!>`	`setPlaylist(@NonNull list: MutableList<String!>, @Nullable metadata: MediaMetadata?)` Sets the playlist with the list of media IDs. Use this or `setMediaItem` to specify which items to play. All media IDs in the list shouldn't be an empty string. The `ControllerCallback#onPlaylistChanged` and `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)` Rate 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)` Sets the repeat mode.
`ListenableFuture<SessionResult!>`	`setShuffleMode(shuffleMode: Int)` Sets the shuffle mode.
`ListenableFuture<SessionResult!>`	`setVolumeTo(value: Int, flags: Int)` Set the volume of the output this session 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 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. This calls `SessionPlayer#skipToNextPlaylistItem()`.
`ListenableFuture<SessionResult!>`	`skipToPlaylistItem(index: Int)` Skips to the item in the playlist at the index. This calls `SessionPlayer#skipToPlaylistItem(int)`.
`ListenableFuture<SessionResult!>`	`skipToPreviousPlaylistItem()` Skips to the previous item in the playlist. This calls `SessionPlayer#skipToPreviousPlaylistItem()`.
`ListenableFuture<SessionResult!>`	`updatePlaylistMetadata(@Nullable metadata: MediaMetadata?)` Updates the playlist metadata

Public methods

getChildren

@NonNull open fun getChildren(
    @NonNull parentId: String, 
    page: Int, 
    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 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, 
    page: Int, 
    pageSize: Int, 
    @Nullable params: MediaLibraryService.LibraryParams?
): ListenableFuture<LibraryResult!>

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`
`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 attemp to search was successful. For getting the search result, waits for BrowserCallback#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

See Also

BrowserCallback#getSearchResult(String, int, int, LibraryParams)#getSearchResult(String, int, int, LibraryParams)

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

MediaBrowser

Summary

Nested classes

Public methods

Inherited functions

Public methods

getChildren

getItem

getLibraryRoot

getSearchResult

search

subscribe

unsubscribe