com.google.android.exoplayer2.ext.mediasession

Class TimelineQueueNavigator

java.lang.Object

com.google.android.exoplayer2.ext.mediasession.TimelineQueueNavigator

All Implemented Interfaces:

MediaSessionConnector.CommandReceiver, MediaSessionConnector.QueueNavigator

public abstract class TimelineQueueNavigator
extends java.lang.Object
implements MediaSessionConnector.QueueNavigator

An abstract implementation of the MediaSessionConnector.QueueNavigator that maps the windows of a Player's Timeline to the media session queue.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_QUEUE_SIZE
static long	MAX_POSITION_FOR_SEEK_TO_PREVIOUS
protected int	maxQueueSize

Fields inherited from interface com.google.android.exoplayer2.ext.mediasession.MediaSessionConnector.QueueNavigator

ACTIONS

Constructor Summary

Constructors

Constructor and Description
TimelineQueueNavigator(android.support.v4.media.session.MediaSessionCompat mediaSession) Creates an instance for a given MediaSessionCompat.
TimelineQueueNavigator(android.support.v4.media.session.MediaSessionCompat mediaSession, int maxQueueSize) Creates an instance for a given MediaSessionCompat and maximum queue size.

Method Summary

Modifier and Type	Method and Description
long	getActiveQueueItemId(com.google.android.exoplayer2.Player player) Gets the id of the currently active queue item, or MediaSessionCompat.QueueItem#UNKNOWN_ID if the active item is unknown.
java.lang.String[]	getCommands() Returns the commands the receiver handles, or null if no commands need to be handled.
abstract android.support.v4.media.MediaDescriptionCompat	getMediaDescription(com.google.android.exoplayer2.Player player, int windowIndex) Gets the MediaDescriptionCompat for a given timeline window index.
long	getSupportedQueueNavigatorActions(com.google.android.exoplayer2.Player player) Returns the actions which are supported by the navigator.
void	onCommand(com.google.android.exoplayer2.Player player, java.lang.String command, android.os.Bundle extras, android.os.ResultReceiver cb) See MediaSessionCompat.Callback#onCommand(String, Bundle, ResultReceiver).
void	onCurrentWindowIndexChanged(com.google.android.exoplayer2.Player player) Called when the current window index changed.
void	onSkipToNext(com.google.android.exoplayer2.Player player) See MediaSessionCompat.Callback#onSkipToNext().
void	onSkipToPrevious(com.google.android.exoplayer2.Player player) See MediaSessionCompat.Callback#onSkipToPrevious().
void	onSkipToQueueItem(com.google.android.exoplayer2.Player player, long id) See MediaSessionCompat.Callback#onSkipToQueueItem(long).
void	onTimelineChanged(com.google.android.exoplayer2.Player player) Called when the timeline of the player has changed.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_POSITION_FOR_SEEK_TO_PREVIOUS

public static final long MAX_POSITION_FOR_SEEK_TO_PREVIOUS

See Also:

Constant Field Values

DEFAULT_MAX_QUEUE_SIZE

public static final int DEFAULT_MAX_QUEUE_SIZE

See Also:

Constant Field Values

maxQueueSize

protected final int maxQueueSize

Constructor Detail

TimelineQueueNavigator

public TimelineQueueNavigator(android.support.v4.media.session.MediaSessionCompat mediaSession)

Creates an instance for a given MediaSessionCompat.

Equivalent to TimelineQueueNavigator(mediaSession, DEFAULT_MAX_QUEUE_SIZE).

Parameters:

mediaSession - The MediaSessionCompat.

TimelineQueueNavigator

public TimelineQueueNavigator(android.support.v4.media.session.MediaSessionCompat mediaSession,
                              int maxQueueSize)

Creates an instance for a given MediaSessionCompat and maximum queue size.

If the number of windows in the Player's Timeline exceeds maxQueueSize, the media session queue will correspond to maxQueueSize windows centered on the one currently being played.

Parameters:

mediaSession - The MediaSessionCompat.

maxQueueSize - The maximum queue size.

Method Detail

getMediaDescription

public abstract android.support.v4.media.MediaDescriptionCompat getMediaDescription(com.google.android.exoplayer2.Player player,
                                                                                    int windowIndex)

Gets the MediaDescriptionCompat for a given timeline window index.

Parameters:

player - The current player.

windowIndex - The timeline window index for which to provide a description.

Returns:

A MediaDescriptionCompat.

getSupportedQueueNavigatorActions

public long getSupportedQueueNavigatorActions(com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

Returns the actions which are supported by the navigator. The supported actions must be a bitmask combined out of PlaybackStateCompat.ACTION_SKIP_TO_QUEUE_ITEM, PlaybackStateCompat.ACTION_SKIP_TO_NEXT, PlaybackStateCompat.ACTION_SKIP_TO_PREVIOUS.

Specified by:

getSupportedQueueNavigatorActions in interface MediaSessionConnector.QueueNavigator

Parameters:

player - The Player.

Returns:

The bitmask of the supported media actions.

onTimelineChanged

public final void onTimelineChanged(com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

Called when the timeline of the player has changed.

Specified by:

onTimelineChanged in interface MediaSessionConnector.QueueNavigator

Parameters:

player - The player of which the timeline has changed.

onCurrentWindowIndexChanged

public final void onCurrentWindowIndexChanged(com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

Called when the current window index changed.

Specified by:

onCurrentWindowIndexChanged in interface MediaSessionConnector.QueueNavigator

Parameters:

player - The player of which the current window index of the timeline has changed.

getActiveQueueItemId

public final long getActiveQueueItemId(@Nullable
                                       com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

Gets the id of the currently active queue item, or MediaSessionCompat.QueueItem#UNKNOWN_ID if the active item is unknown.

To let the connector publish metadata for the active queue item, the queue item with the returned id must be available in the list of items returned by MediaControllerCompat.getQueue().

Specified by:

getActiveQueueItemId in interface MediaSessionConnector.QueueNavigator

Parameters:

player - The player connected to the media session.

Returns:

The id of the active queue item.

onSkipToPrevious

public void onSkipToPrevious(com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

See MediaSessionCompat.Callback#onSkipToPrevious().

Specified by:

onSkipToPrevious in interface MediaSessionConnector.QueueNavigator

onSkipToQueueItem

public void onSkipToQueueItem(com.google.android.exoplayer2.Player player,
                              long id)

Description copied from interface: MediaSessionConnector.QueueNavigator

See MediaSessionCompat.Callback#onSkipToQueueItem(long).

Specified by:

onSkipToQueueItem in interface MediaSessionConnector.QueueNavigator

onSkipToNext

public void onSkipToNext(com.google.android.exoplayer2.Player player)

Description copied from interface: MediaSessionConnector.QueueNavigator

See MediaSessionCompat.Callback#onSkipToNext().

Specified by:

onSkipToNext in interface MediaSessionConnector.QueueNavigator

getCommands

public java.lang.String[] getCommands()

Description copied from interface: MediaSessionConnector.CommandReceiver

Returns the commands the receiver handles, or null if no commands need to be handled.

Specified by:

getCommands in interface MediaSessionConnector.CommandReceiver

onCommand

public void onCommand(com.google.android.exoplayer2.Player player,
                      java.lang.String command,
                      android.os.Bundle extras,
                      android.os.ResultReceiver cb)

Description copied from interface: MediaSessionConnector.CommandReceiver

See MediaSessionCompat.Callback#onCommand(String, Bundle, ResultReceiver).

Specified by:

onCommand in interface MediaSessionConnector.CommandReceiver