com.moppyandroid.main.service

Class MusicQueue

java.lang.Object

com.moppyandroid.main.service.MusicQueue

public class MusicQueue
extends Object

Represents a queue of MediaSessionCompat.QueueItems that manages the current playing item, as well as maintains a window to be used with MediaSessionCompat.setQueue(List).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MusicQueue.Callback Callback triggered when the available queue manipulation options change.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WINDOW_SIZE The maximum size of the queue window/subset handed to the MediaSessionCompat.

Constructor Summary

Constructors

Constructor and Description
MusicQueue(MediaSessionCompat mediaSession) Constructs a MusicQueue without a MusicQueue.Callback.
MusicQueue(MediaSessionCompat mediaSession, MusicQueue.Callback actionsCallback) Constructs a MusicQueue with a MusicQueue.Callback.

Method Summary

Modifier and Type	Method and Description
void	addToQueue(MediaDescriptionCompat description) Adds a song to the end of the music queue.
boolean	addToQueue(MediaDescriptionCompat description, int index) Adds a song to the music queue at a specific index.
boolean	checkNextSongAvailable() Checks if there is another song forward in the queue that can be played with skipToNext().
boolean	checkPreviousSongAvailable() Checks if there are any previous songs in the queue that can be played with skipToPrevious().
boolean	checkSongAvailable(int index) Checks if there is a song available at a specific index.
boolean	checkSongAvailable(long id) Checks if an ID corresponds to a song in the queue.
boolean	checkSongAvailable(MediaDescriptionCompat description) Checks if a song is in the queue.
long	getActions() Gets the currently available PlaybackStateCompat actions.
MediaSessionCompat.QueueItem	getCurrentSong() Gets the currently-playing song.
int	getIndex() Gets the index of the playing song in the full music queue.
int	getNextSongCount() Gets the number of songs forward in the queue, equivalent to the number of times skipToNext() can be successfully called.
int	getPreviousSongCount() Gets the number of songs backward in the queue, equivalent to the number of times skipToPrevious() can be successfully called.
int	getQueueSize() Gets the total size of the current music queue.
List<MediaSessionCompat.QueueItem>	getQueueSublist(int fromIndex, int toIndex) Gets a section of the current music queue between fromIndex (inclusive) and toIndex (exclusive).
int	getWindowIndex() Gets the index of the playing item in the current window of the music queue.
int	getWindowOffset() Gets the offset of the current window in the full music queue.
MediaSessionCompat.QueueItem	peekNextSong() Gets the next song if available, without modifying the queue.
MediaSessionCompat.QueueItem	peekPreviousSong() Gets the previous song if available, without modifying the queue.
MediaSessionCompat.QueueItem	peekSong(int index) Gets the song at a specific index.
MediaSessionCompat.QueueItem	peekSong(long id) Gets the song associated with a specific ID.
MediaSessionCompat.QueueItem	peekWindowSong(int index) Gets the song at a specific index in the current window of the music queue.
boolean	removeFromQueue(int index) Removes a song at a specific index from the queue.
boolean	removeFromQueue(long id) Removes a specific song from the queue by its ID.
boolean	removeFromQueue(MediaDescriptionCompat description) Removes a specific song from the queue.
MediaSessionCompat.QueueItem	skipToNext() Skips to the next song in the queue.
MediaSessionCompat.QueueItem	skipToNext(int times) Skips forward in the queue a number of times.
MediaSessionCompat.QueueItem	skipToPrevious() Skips to the previous song in the queue.
MediaSessionCompat.QueueItem	skipToPrevious(int times) Skips backward in the queue a number of times.
MediaSessionCompat.QueueItem	skipToSong(int index) Skips to the song at a specific index in the queue.
MediaSessionCompat.QueueItem	skipToSong(long id) Skips to a specific song in the queue.

Methods inherited from class java.lang.Object

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

Field Detail

WINDOW_SIZE

public static final int WINDOW_SIZE

The maximum size of the queue window/subset handed to the MediaSessionCompat.

See Also:

Constant Field Values

Constructor Detail

MusicQueue

public MusicQueue(MediaSessionCompat mediaSession)

Constructs a MusicQueue without a MusicQueue.Callback.

Parameters:

mediaSession - the media session the queue is posted to

See Also:

MusicQueue(MediaSessionCompat, Callback)

MusicQueue

public MusicQueue(MediaSessionCompat mediaSession,
                  MusicQueue.Callback actionsCallback)

Constructs a MusicQueue with a MusicQueue.Callback.

Parameters:

mediaSession - the media session the queue is posted to

actionsCallback - the callback triggered when the available actions change

Method Detail

addToQueue

public void addToQueue(MediaDescriptionCompat description)

Adds a song to the end of the music queue.

Parameters:

description - the song to add

addToQueue

public boolean addToQueue(MediaDescriptionCompat description,
                          int index)

Adds a song to the music queue at a specific index.

Parameters:

description - the song to add

index - the index to insert the song at

Returns:

true if a song reload is suggested due to the song being inserted at the position of the currently-playing song

Throws:

IndexOutOfBoundsException - if index < 0 or index > getQueueSize() (one passed current final index)

removeFromQueue

public boolean removeFromQueue(MediaDescriptionCompat description)

Removes a specific song from the queue.

Parameters:

description - the song to remove

Returns:

true if the currently-playing song was removed and a song reload is necessary

removeFromQueue

public boolean removeFromQueue(long id)

Removes a specific song from the queue by its ID.

Parameters:

id - the ID of the song to remove

Returns:

true if the currently-playing song was removed and a song reload is necessary

removeFromQueue

public boolean removeFromQueue(int index)

Removes a song at a specific index from the queue.

Parameters:

index - the index of the song to remove

Returns:

true if the currently-playing song was removed and a song reload is necessary

Throws:

IndexOutOfBoundsException - if index < 0 or index >= getQueueSize() (index of final song)

skipToSong

public MediaSessionCompat.QueueItem skipToSong(long id)

Skips to a specific song in the queue.

Parameters:

id - the ID of the song to skip to

Returns:

null if id doesn't match a song, otherwise the song that was skipped to

skipToSong

public MediaSessionCompat.QueueItem skipToSong(int index)

Skips to the song at a specific index in the queue.

Parameters:

index - the index of the song to skip to

Returns:

null if index doesn't exist in the queue, otherwise the song that was skipped to

skipToNext

public MediaSessionCompat.QueueItem skipToNext()

Skips to the next song in the queue.

Returns:

null if there are no songs left in the queue, otherwise the song that was skipped to

skipToNext

public MediaSessionCompat.QueueItem skipToNext(int times)

Skips forward in the queue a number of times. If there aren't enough songs left to skip forward the requested number of times, null is returned and the queue remains unchanged.

Parameters:

times - the number of times to skip forward

Returns:

null if the queue couldn't be skipped as requested, otherwise the song that was skipped to

skipToPrevious

public MediaSessionCompat.QueueItem skipToPrevious()

Skips to the previous song in the queue.

Returns:

null if there are no previous songs left in the queue, otherwise the song that was skipped to

skipToPrevious

public MediaSessionCompat.QueueItem skipToPrevious(int times)

Skips backward in the queue a number of times. If there aren't enough songs left to skip backward the requested number of times, null is returned and the queue remains unchanged.

Parameters:

times - the number of times to skip backward

Returns:

null if the queue couldn't be skipped as requested, otherwise the song that was skipped to

getCurrentSong

public MediaSessionCompat.QueueItem getCurrentSong()

Gets the currently-playing song.

Returns:

null if no song is supposed to be playing, otherwise the current song

peekSong

public MediaSessionCompat.QueueItem peekSong(long id)

Gets the song associated with a specific ID.

Parameters:

id - the ID of the song to find

Returns:

null if no song is represented by id, otherwise the requested song

See Also:

skipToSong(long)

peekSong

public MediaSessionCompat.QueueItem peekSong(int index)

Gets the song at a specific index.

Parameters:

index - the index of the song to find

Returns:

null if index doesn't exist in the queue, otherwise the requested song

See Also:

skipToSong(int)

peekWindowSong

public MediaSessionCompat.QueueItem peekWindowSong(int index)

Gets the song at a specific index in the current window of the music queue.

Parameters:

index - the index of the song to find

Returns:

null if the index doesn't exist in the window, otherwise the requested song

See Also:

skipToSong(int)

peekNextSong

public MediaSessionCompat.QueueItem peekNextSong()

Gets the next song if available, without modifying the queue.

Returns:

null if there are no songs left in the queue, otherwise the next song

See Also:

skipToNext()

peekPreviousSong

public MediaSessionCompat.QueueItem peekPreviousSong()

Gets the previous song if available, without modifying the queue.

Returns:

null if there are no previous songs left in the queue, otherwise the previous song

See Also:

skipToPrevious()

checkSongAvailable

public boolean checkSongAvailable(MediaDescriptionCompat description)

Checks if a song is in the queue.

Parameters:

description - the song to check for

Returns:

true if description matches a song in the queue, otherwise false

checkSongAvailable

public boolean checkSongAvailable(long id)

Checks if an ID corresponds to a song in the queue.

Parameters:

id - the ID to find the associated song with

Returns:

true if id corresponds to a song in the queue, otherwise false

checkSongAvailable

public boolean checkSongAvailable(int index)

Checks if there is a song available at a specific index.

Parameters:

index - the index to check for a song

Returns:

true if index corresponds to a song in the queue, otherwise false

checkNextSongAvailable

public boolean checkNextSongAvailable()

Checks if there is another song forward in the queue that can be played with skipToNext().

Returns:

true if another song is available, otherwise false

checkPreviousSongAvailable

public boolean checkPreviousSongAvailable()

Checks if there are any previous songs in the queue that can be played with skipToPrevious().

Returns:

true if another song is available, otherwise false

getActions

public long getActions()

Gets the currently available PlaybackStateCompat actions.

Returns:

the currently available actions

getQueueSize

public int getQueueSize()

Gets the total size of the current music queue.

Returns:

the size of the queue

getQueueSublist

public List<MediaSessionCompat.QueueItem> getQueueSublist(int fromIndex,
                                                          int toIndex)

Gets a section of the current music queue between fromIndex (inclusive) and toIndex (exclusive).

Parameters:

fromIndex - the index of the first element to include, must be greater than 0

toIndex - the index of the first element to not include, must be greater than fromIndex and not exceed getQueueSize()

Returns:

the sublist of the music queue in the range [fromIndex, toIndex)

getIndex

public int getIndex()

Gets the index of the playing song in the full music queue.

Returns:

the playing song's full index

getWindowOffset

public int getWindowOffset()

Gets the offset of the current window in the full music queue.

Returns:

the offset

getWindowIndex

public int getWindowIndex()

Gets the index of the playing item in the current window of the music queue.

Returns:

the playing item's window index

See Also:

getWindowOffset(), getIndex()

getNextSongCount

public int getNextSongCount()

Gets the number of songs forward in the queue, equivalent to the number of times skipToNext() can be successfully called. Doesn't include the current song.

Returns:

the number of songs ahead of the queue head

getPreviousSongCount

public int getPreviousSongCount()

Gets the number of songs backward in the queue, equivalent to the number of times skipToPrevious() can be successfully called. Doesn't include the current song.

Returns:

the number of songs behind the queue head