com.apple.android.music.playback.queue

Class CatalogPlaybackQueueItemProvider

java.lang.Object

com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

com.apple.android.music.playback.queue.CatalogPlaybackQueueItemProvider

All Implemented Interfaces:

com.apple.android.music.playback.queue.PlaybackQueueItemProvider, Externalizable, Serializable

public final class CatalogPlaybackQueueItemProvider
extends com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

An object that populates the playback queue with items from the Apple Music Catalog.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogPlaybackQueueItemProvider.Builder A constructor that defines the builder for a catalog playback queue item provider.

Nested classes/interfaces inherited from interface com.apple.android.music.playback.queue.PlaybackQueueItemProvider

com.apple.android.music.playback.queue.PlaybackQueueItemProvider.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR The creator of the playback queue.

Constructor Summary

Constructors

Constructor and Description
CatalogPlaybackQueueItemProvider()

Method Summary

Modifier and Type	Method and Description
long	getContainerPersistentId() Gets the persistent id for the media container this provider represents, or 0 if this provider does not represent a media container or the container does not have a persistent id.
String	getContainerStoreId() Gets the store id for the media container this provider represents, or null if this provider does not represent a media container.
int	getContainerType() Gets the media container type this provider represents.
PlayerMediaItem	getItemAtIndex(int index) Gets the item at the specified index in this provider, or null if no element exists at the specified index.
int	getItemCount() Gets the total number of media items this provider contains.
void	populatePlayActivityEventForIndex(com.apple.android.music.playback.reporting.PlayActivityEventBuilder builder, int index) Populates the given PlayActivityEventBuilder with data for the item at the specified index.
void	readExternal(ObjectInput in)
void	release(boolean deleteCache) Releases this instance.
void	writeExternal(ObjectOutput out)
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

canAddToPlaybackQueue, canSetRadioLikeStateForIndex, describeContents, getContainerHashId, getGlobalShuffleMode, getId, getShuffleMode, getStartItemIndex, handleMessage, isDynamic, prepare, setCurrentIndex, setGlobalShuffleMode, setId, setRadioLikeStateForIndex, setShuffleMode, updatePlaybackMetadataForIndex

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final <any> CREATOR

The creator of the playback queue.

Constructor Detail

CatalogPlaybackQueueItemProvider

public CatalogPlaybackQueueItemProvider()

Method Detail

getContainerPersistentId

public long getContainerPersistentId()

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Gets the persistent id for the media container this provider represents, or 0 if this provider does not represent a media container or the container does not have a persistent id.

Returns:

The container persistent id, or 0.

getContainerStoreId

@Nullable
public String getContainerStoreId()

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Gets the store id for the media container this provider represents, or null if this provider does not represent a media container.

Returns:

The container store id, or null.

getContainerType

public int getContainerType()

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Gets the media container type this provider represents.

Returns:

The media container type.

getItemAtIndex

@Nullable
public PlayerMediaItem getItemAtIndex(int index)

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Gets the item at the specified index in this provider, or null if no element exists at the specified index.

Parameters:

index - The index to fetch.

Returns:

The PlayerMediaItem at the specified index, or null.

getItemCount

public int getItemCount()

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Gets the total number of media items this provider contains.

Returns:

The number of items.

populatePlayActivityEventForIndex

public void populatePlayActivityEventForIndex(@NonNull
                                              com.apple.android.music.playback.reporting.PlayActivityEventBuilder builder,
                                              int index)

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Populates the given PlayActivityEventBuilder with data for the item at the specified index.

Specified by:

populatePlayActivityEventForIndex in interface com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Overrides:

populatePlayActivityEventForIndex in class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

Parameters:

builder - A PlayActivityEventBuilder to populate.

index - The index of the item to use for data.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

Throws:

IOException

ClassNotFoundException

release

public void release(boolean deleteCache)

Description copied from interface: com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Releases this instance. This method should be used to clean up any resources used. After this is called, this instance should no longer be used.

Specified by:

release in interface com.apple.android.music.playback.queue.PlaybackQueueItemProvider

Overrides:

release in class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider

Throws:

IOException

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Overrides:

writeToParcel in class com.apple.android.music.playback.queue.BasePlaybackQueueItemProvider