ControllerCallback

<init>

ControllerCallback()

Interface for listening to change in activeness of the MediaSession. It's active if and only if it has set a player.

onAllowedCommandsChanged

open fun onAllowedCommandsChanged(
    @NonNull controller: MediaController, 
    @NonNull commands: SessionCommandGroup
): Unit

Called when the allowed commands are changed by session.

onBufferingStateChanged

open fun onBufferingStateChanged(
    @NonNull controller: MediaController, 
    @NonNull item: MediaItem, 
    state: Int
): Unit

Called to report buffering events for a media item.

Use getBufferedPosition() for current buffering position.

onConnected

open fun onConnected(
    @NonNull controller: MediaController, 
    @NonNull allowedCommands: SessionCommandGroup
): Unit

Called when the controller is successfully connected to the session. The controller becomes available afterwards.

onCurrentMediaItemChanged

open fun onCurrentMediaItemChanged(
    @NonNull controller: MediaController, 
    @Nullable item: MediaItem?
): Unit

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.

onCustomCommand

@NonNull open fun onCustomCommand(
    @NonNull controller: MediaController, 
    @NonNull command: SessionCommand, 
    @Nullable args: Bundle?
): SessionResult

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.

onDisconnected

open fun onDisconnected(@NonNull controller: MediaController): Unit

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.

onPlaybackCompleted

open fun onPlaybackCompleted(@NonNull controller: MediaController): Unit

Called when the playback is completed.

onPlaybackInfoChanged

open fun onPlaybackInfoChanged(
    @NonNull controller: MediaController, 
    @NonNull info: MediaController.PlaybackInfo
): Unit

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.

onPlaybackSpeedChanged

open fun onPlaybackSpeedChanged(
    @NonNull controller: MediaController, 
    speed: Float
): Unit

Called when playback speed is changed.

onPlayerStateChanged

open fun onPlayerStateChanged(
    @NonNull controller: MediaController, 
    state: Int
): Unit

Called when the player state is changed.

onPlaylistChanged

open fun onPlaylistChanged(
    @NonNull controller: MediaController, 
    @Nullable list: MutableList<MediaItem!>?, 
    @Nullable metadata: MediaMetadata?
): Unit

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.

onPlaylistMetadataChanged

open fun onPlaylistMetadataChanged(
    @NonNull controller: MediaController, 
    @Nullable metadata: MediaMetadata?
): Unit

Called when a playlist metadata is changed.

onRepeatModeChanged

open fun onRepeatModeChanged(
    @NonNull controller: MediaController, 
    repeatMode: Int
): Unit

Called when the repeat mode is changed.

onSeekCompleted

open fun onSeekCompleted(
    @NonNull controller: MediaController, 
    position: Long
): Unit

Called to indicate that seeking is completed.

onSetCustomLayout

open fun onSetCustomLayout(
    @NonNull controller: MediaController, 
    @NonNull layout: MutableList<MediaSession.CommandButton!>
): Int

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.

onShuffleModeChanged

open fun onShuffleModeChanged(
    @NonNull controller: MediaController, 
    shuffleMode: Int
): Unit

Called when the shuffle mode is changed.

onSubtitleData

open fun onSubtitleData(
    @NonNull controller: MediaController, 
    @NonNull item: MediaItem, 
    @NonNull track: SessionPlayer.TrackInfo, 
    @NonNull data: SubtitleData
): Unit

Called when the subtitle track has new subtitle data available.

onTrackDeselected

open fun onTrackDeselected(
    @NonNull controller: MediaController, 
    @NonNull trackInfo: SessionPlayer.TrackInfo
): Unit

Called when a track is deselected.

The types of tracks supported may vary based on player implementation, but generally a track should already be selected in order to be deselected and audio and video tracks should not be deselected.

onTrackSelected

open fun onTrackSelected(
    @NonNull controller: MediaController, 
    @NonNull trackInfo: SessionPlayer.TrackInfo
): Unit

Called when a track is selected.

The types of tracks supported may vary based on player implementation, but generally one track will be selected for each track type.

onTracksChanged

open fun onTracksChanged(
    @NonNull controller: MediaController, 
    @NonNull tracks: MutableList<SessionPlayer.TrackInfo!>
): Unit

Called when the tracks of the current media item is changed such as 1) when tracks of a media item become available, 2) when new tracks are found during playback, or 3) when the current media item is changed.

When it's called, you should invalidate previous track information and use the new tracks to call selectTrack(TrackInfo) or deselectTrack(TrackInfo).

The types of tracks supported may vary based on player implementation.