com.google.android.exoplayer2.ext.mediasession

Class MediaSessionConnector

java.lang.Object

com.google.android.exoplayer2.ext.mediasession.MediaSessionConnector

public final class MediaSessionConnector
extends Object

Connects a MediaSessionCompat to a Player.

The connector listens for actions sent by the media session's controller and implements these actions by calling appropriate ExoPlayer methods. The playback state of the media session is automatically synced with the player. The connector can also be optionally extended by providing various collaborators:

• Actions to initiate media playback (PlaybackStateCompat#ACTION_PREPARE_* and PlaybackStateCompat#ACTION_PLAY_*) can be handled by a MediaSessionConnector.PlaybackPreparer passed when calling setPlayer(Player, PlaybackPreparer, CustomActionProvider...). Custom actions can be handled by passing one or more MediaSessionConnector.CustomActionProviders in a similar way.
• To enable a media queue and navigation within it, you can set a MediaSessionConnector.QueueNavigator by calling setQueueNavigator(QueueNavigator). Use of TimelineQueueNavigator is recommended for most use cases.
• To enable editing of the media queue, you can set a MediaSessionConnector.QueueEditor by calling setQueueEditor(QueueEditor).
• An MediaSessionConnector.ErrorMessageProvider for providing human readable error messages and corresponding error codes can be set by calling setErrorMessageProvider(ErrorMessageProvider).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaSessionConnector.CustomActionProvider Provides a PlaybackStateCompat.CustomAction to be published and handles the action when sent by a media controller.
static interface	MediaSessionConnector.ErrorMessageProvider Converts an exception into an error code and a user readable error message.
static interface	MediaSessionConnector.PlaybackController Interface to which playback actions are delegated.
static interface	MediaSessionConnector.PlaybackPreparer Interface to which playback preparation actions are delegated.
static interface	MediaSessionConnector.QueueEditor Handles media session queue edits.
static interface	MediaSessionConnector.QueueNavigator Handles queue navigation actions, and updates the media session queue by calling MediaSessionCompat.setQueue().

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTRAS_PITCH
MediaSessionCompat	mediaSession The wrapped MediaSessionCompat.

Constructor Summary

Constructors

Constructor and Description
MediaSessionConnector(MediaSessionCompat mediaSession) Creates an instance.
MediaSessionConnector(MediaSessionCompat mediaSession, MediaSessionConnector.PlaybackController playbackController) Creates an instance.
MediaSessionConnector(MediaSessionCompat mediaSession, MediaSessionConnector.PlaybackController playbackController, boolean doMaintainMetadata) Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	setErrorMessageProvider(MediaSessionConnector.ErrorMessageProvider errorMessageProvider) Sets the MediaSessionConnector.ErrorMessageProvider.
void	setPlayer(Player player, MediaSessionConnector.PlaybackPreparer playbackPreparer, MediaSessionConnector.CustomActionProvider... customActionProviders) Sets the player to be connected to the media session.
void	setQueueEditor(MediaSessionConnector.QueueEditor queueEditor) Sets the MediaSessionConnector.QueueEditor to handle queue edits sent by the media controller.
void	setQueueNavigator(MediaSessionConnector.QueueNavigator queueNavigator) Sets the MediaSessionConnector.QueueNavigator to handle queue navigation actions ACTION_SKIP_TO_NEXT, ACTION_SKIP_TO_PREVIOUS, ACTION_SKIP_TO_QUEUE_ITEM and ACTION_SET_SHUFFLE_MODE_ENABLED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTRAS_PITCH

public static final String EXTRAS_PITCH

See Also:

Constant Field Values

mediaSession

public final MediaSessionCompat mediaSession

The wrapped MediaSessionCompat.

Constructor Detail

MediaSessionConnector

public MediaSessionConnector(MediaSessionCompat mediaSession)

Creates an instance. Must be called on the same thread that is used to construct the player instances passed to setPlayer(Player, PlaybackPreparer, CustomActionProvider...).

Equivalent to MediaSessionConnector(mediaSession, new DefaultPlaybackController()).

Parameters:

mediaSession - The MediaSessionCompat to connect to.

MediaSessionConnector

public MediaSessionConnector(MediaSessionCompat mediaSession,
                             MediaSessionConnector.PlaybackController playbackController)

Creates an instance. Must be called on the same thread that is used to construct the player instances passed to setPlayer(Player, PlaybackPreparer, CustomActionProvider...).

Equivalent to MediaSessionConnector(mediaSession, playbackController, true).

Parameters:

mediaSession - The MediaSessionCompat to connect to.

playbackController - A MediaSessionConnector.PlaybackController for handling playback actions.

MediaSessionConnector

public MediaSessionConnector(MediaSessionCompat mediaSession,
                             MediaSessionConnector.PlaybackController playbackController,
                             boolean doMaintainMetadata)

Creates an instance. Must be called on the same thread that is used to construct the player instances passed to setPlayer(Player, PlaybackPreparer, CustomActionProvider...).

Parameters:

mediaSession - The MediaSessionCompat to connect to.

playbackController - A MediaSessionConnector.PlaybackController for handling playback actions.

doMaintainMetadata - Whether the connector should maintain the metadata of the session. If false, you need to maintain the metadata of the media session yourself (provide at least the duration to allow clients to show a progress bar).

Method Detail

setPlayer

public void setPlayer(Player player,
                      MediaSessionConnector.PlaybackPreparer playbackPreparer,
                      MediaSessionConnector.CustomActionProvider... customActionProviders)

Sets the player to be connected to the media session.

The order in which any MediaSessionConnector.CustomActionProviders are passed determines the order of the actions published with the playback state of the session.

Parameters:

player - The player to be connected to the MediaSession.

playbackPreparer - An optional MediaSessionConnector.PlaybackPreparer for preparing the player.

customActionProviders - An optional MediaSessionConnector.CustomActionProviders to publish and handle custom actions.

setErrorMessageProvider

public void setErrorMessageProvider(MediaSessionConnector.ErrorMessageProvider errorMessageProvider)

Sets the MediaSessionConnector.ErrorMessageProvider.

Parameters:

errorMessageProvider - The error message provider.

setQueueNavigator

public void setQueueNavigator(MediaSessionConnector.QueueNavigator queueNavigator)

Sets the MediaSessionConnector.QueueNavigator to handle queue navigation actions ACTION_SKIP_TO_NEXT, ACTION_SKIP_TO_PREVIOUS, ACTION_SKIP_TO_QUEUE_ITEM and ACTION_SET_SHUFFLE_MODE_ENABLED.

Parameters:

queueNavigator - The queue navigator.

setQueueEditor

public void setQueueEditor(MediaSessionConnector.QueueEditor queueEditor)

Sets the MediaSessionConnector.QueueEditor to handle queue edits sent by the media controller.

Parameters:

queueEditor - The queue editor.