BrowserCallback

Kotlin |Java

open class BrowserCallback : MediaController.ControllerCallback

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

Callback to listen events from MediaLibraryService.

Summary

Public constructors
`<init>()` Callback to listen events from `MediaLibraryService`.

Public methods
open Unit	`onChildrenChanged(@NonNull browser: MediaBrowser, @NonNull parentId: String, itemCount: Int, @Nullable params: MediaLibraryService.LibraryParams?)` Called when there's change in the parent's children after you've subscribed to the parent with `subscribe`.
open Unit	`onSearchResultChanged(@NonNull browser: MediaBrowser, @NonNull query: String, itemCount: Int, @Nullable params: MediaLibraryService.LibraryParams?)` Called when there's change in the search result requested by the previous `MediaBrowser#search(String, LibraryParams)`.

Inherited functions

From class ControllerCallback

`Unit`	`onAllowedCommandsChanged(@NonNull controller: MediaController, @NonNull commands: SessionCommandGroup)` Called when the allowed commands are changed by session.
`Unit`	`onBufferingStateChanged(@NonNull controller: MediaController, @NonNull item: MediaItem, state: Int)` Called to report buffering events for a media item. Use `getBufferedPosition()` for current buffering position.
`Unit`	`onConnected(@NonNull controller: MediaController, @NonNull allowedCommands: SessionCommandGroup)` Called when the controller is successfully connected to the session. The controller becomes available afterwards.
`Unit`	`onCurrentMediaItemChanged(@NonNull controller: MediaController, @Nullable item: MediaItem?)` Called when the current item is changed. It's also called after `setPlaylist` or `setMediaItem`. Also called when `MediaItem#setMetadata(MediaMetadata)` is called on the current media item. When it's called, you should invalidate previous playback information and wait for later callbacks. Also, current, previous, and next media item indices may need to be updated.
`SessionResult`	`onCustomCommand(@NonNull controller: MediaController, @NonNull command: SessionCommand, @Nullable args: Bundle?)` Called when the session sent a custom command. Returns a `SessionResult` for session to get notification back. If the `null` is returned, `SessionResult#RESULT_ERROR_UNKNOWN` will be returned. Default implementation returns `SessionResult#RESULT_ERROR_NOT_SUPPORTED`.
`Unit`	`onDisconnected(@NonNull controller: MediaController)` Called when the session refuses the controller or the controller is disconnected from the session. The controller becomes unavailable afterwards and the callback wouldn't be called. It will be also called after the `close()`, so you can put clean up code here. You don't need to call `close()` after this.
`Unit`	`onPlaybackCompleted(@NonNull controller: MediaController)` Called when the playback is completed.
`Unit`	`onPlaybackInfoChanged(@NonNull controller: MediaController, @NonNull info: MediaController.PlaybackInfo)` Called when the session has changed anything related with the `PlaybackInfo`. Interoperability: When connected to `android.support.v4.media.session.MediaSessionCompat`, this may be called when the session changes playback info by calling `android.support.v4.media.session.MediaSessionCompat#setPlaybackToLocal(int)` or `android.support.v4.media.session.MediaSessionCompat#setPlaybackToRemote( * VolumeProviderCompat)`}. Specifically: Prior to API 21, this will always be called whenever any of those two methods is called. From API 21 to 22, this is called only when the playback type is changed from local to remote (i.e. not from remote to local). From API 23, this is called only when the playback type is changed.
`Unit`	`onPlaybackSpeedChanged(@NonNull controller: MediaController, speed: Float)` Called when playback speed is changed.
`Unit`	`onPlayerStateChanged(@NonNull controller: MediaController, state: Int)` Called when the player state is changed.
`Unit`	`onPlaylistChanged(@NonNull controller: MediaController, @Nullable list: MutableList<MediaItem!>?, @Nullable metadata: MediaMetadata?)` Called when a playlist is changed. It's also called after `setPlaylist` or `setMediaItem`. Also called when `MediaItem#setMetadata(MediaMetadata)` is called on a media item that is contained in the current playlist. When it's called, current, previous, and next media item indices may need to be updated.
`Unit`	`onPlaylistMetadataChanged(@NonNull controller: MediaController, @Nullable metadata: MediaMetadata?)` Called when a playlist metadata is changed.
`Unit`	`onRepeatModeChanged(@NonNull controller: MediaController, repeatMode: Int)` Called when the repeat mode is changed.
`Unit`	`onSeekCompleted(@NonNull controller: MediaController, position: Long)` Called to indicate that seeking is completed.
`Int`	`onSetCustomLayout(@NonNull controller: MediaController, @NonNull layout: MutableList<MediaSession.CommandButton!>)` Called when the session set the custom layout through the `MediaSession#setCustomLayout(MediaSession.ControllerInfo, List)`. Can be called before `onConnected(MediaController, SessionCommandGroup)` is called. Default implementation returns `SessionResult#RESULT_ERROR_NOT_SUPPORTED`.
`Unit`	`onShuffleModeChanged(@NonNull controller: MediaController, shuffleMode: Int)` Called when the shuffle mode is changed.

Public constructors

<init>

BrowserCallback()

Callback to listen events from MediaLibraryService.

Public methods

onChildrenChanged

open fun onChildrenChanged(
    @NonNull browser: MediaBrowser, 
    @NonNull parentId: String, 
    itemCount: Int, 
    @Nullable params: MediaLibraryService.LibraryParams?
): Unit

Called when there's change in the parent's children after you've subscribed to the parent with subscribe.

This API is called when the library service called MediaLibraryService.MediaLibrarySession#notifyChildrenChanged for the parent.

Parameters
`browser`	MediaBrowser: the browser for this event
`parentId`	String: non-empty parent id that you've specified with `subscribe(String, LibraryParams)`
`itemCount`	Int: number of children
`params`	MediaLibraryService.LibraryParams?: library params from the library service. Can be differ from params that you've specified with `subscribe(String, LibraryParams)`.

onSearchResultChanged

open fun onSearchResultChanged(
    @NonNull browser: MediaBrowser, 
    @NonNull query: String, 
    itemCount: Int, 
    @Nullable params: MediaLibraryService.LibraryParams?
): Unit

Called when there's change in the search result requested by the previous MediaBrowser#search(String, LibraryParams).

Parameters
`browser`	MediaBrowser: the browser for this event
`query`	String: non-empty search query that you've specified with `search(String, LibraryParams)`
`itemCount`	Int: The item count for the search result
`params`	MediaLibraryService.LibraryParams?: library params from the library service. Can be differ from params that you've specified with `search(String, LibraryParams)`.