MediaController.Listener

default void onAvailableSessionCommandsChanged(
    MediaController controller,
    SessionCommands commands
)

Called when the available session commands are changed by session.

default ListenableFuture<SessionResult> onCustomCommand(
    MediaController controller,
    SessionCommand command,
    Bundle args
)

Called when the session sends a custom command through sendCustomCommand.

Return a ListenableFuture to reply with a SessionResult to the session asynchronously. You can also return a SessionResult directly by using Guava's immediateFuture.

The default implementation returns ListenableFuture of ERROR_NOT_SUPPORTED.

default void onCustomLayoutChanged(
    MediaController controller,
    List<CommandButton> layout
)

Called when the custom layout changed.

This method will be deprecated, prefer to use onMediaButtonPreferencesChanged. Note that the media button preferences use slots to define the allowed button placement.

The custom layout can change when either the session changes the custom layout, or when the session changes the available commands for a controller that affect whether buttons of the custom layout are enabled or disabled.

Note that the enabled flag is set to false if the available commands do not allow to use a button.

default void onDisconnected(MediaController controller)

Called when the controller is disconnected from the session. The controller becomes unavailable afterwards and this listener won't be called anymore.

It will be also called after the release, so you can put clean up code here. You don't need to call release after this.

@UnstableApi
default void onError(MediaController controller, SessionError sessionError)

Called when an non-fatal error sent by the session is received.

When connected to a legacy or platform session, this callback is called when onPlaybackStateChanged is called with an error code and an error message while the playback state is different to state error.

Fatal playback errors are reported to onPlayerError and onPlayerErrorChanged of listeners registered on the controller.

default void onExtrasChanged(MediaController controller, Bundle extras)

Called when the session extras are set on the session side.

@UnstableApi
default void onMediaButtonPreferencesChanged(
    MediaController controller,
    List<CommandButton> mediaButtonPreferences
)

Called when the media button preferences changed.

The media button preferences can change when either the session changes the media button preferences, or when the session changes the available commands for a controller that affect whether buttons of the media button preferences are enabled or disabled.

Note that the enabled flag is set to false if the available commands do not allow to use a button.

@UnstableApi
default void onSessionActivityChanged(
    MediaController controller,
    @Nullable PendingIntent sessionActivity
)

Called when the PendingIntent to launch the session activity has been changed on the session side.

default ListenableFuture<SessionResult> onSetCustomLayout(
    MediaController controller,
    List<CommandButton> layout
)

Called when the session sets the custom layout through setCustomLayout.

This method will be deprecated. Use onCustomLayoutChanged instead.

There is a slight difference in behaviour. This to be deprecated method may be consecutively called with an unchanged custom layout passed into it, in which case the new onCustomLayoutChanged isn't called again for equal arguments.

Further, when the available commands of a controller change in a way that affect whether buttons of the custom layout are enabled or disabled, the new callback onCustomLayoutChanged is called, in which case the deprecated callback isn't called.