com.apple.android.music.playback.queue

Class CatalogPlaybackQueueItemProvider.Builder

java.lang.Object

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

Enclosing class:

CatalogPlaybackQueueItemProvider

public static final class CatalogPlaybackQueueItemProvider.Builder
extends Object

A constructor that defines the builder for a catalog playback queue item provider.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
com.apple.android.music.playback.queue.PlaybackQueueItemProvider	build() Creates a new catalog playback queue item provider using the values specified to this builder.
CatalogPlaybackQueueItemProvider.Builder	containers(int containerType, String... containerIds) Creates a playback queue populated by item containers with the specified IDs, which will be in the order of their containers, followed by the order of the IDs, unless a shuffle mode is set.
CatalogPlaybackQueueItemProvider.Builder	items(int itemType, String... itemIds) Creates a playback queue populated by items with the specified IDs, which will be in the order specified unless a shuffle mode is set.
CatalogPlaybackQueueItemProvider.Builder	shuffleMode(int shuffleMode) Sets the desired playback shuffle mode for the playback queue.
CatalogPlaybackQueueItemProvider.Builder	startItemIndex(int startItemIndex) Starts playback from the specified index, rather than from the start of the playback queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public com.apple.android.music.playback.queue.PlaybackQueueItemProvider build()

Creates a new catalog playback queue item provider using the values specified to this builder.

Returns:

A new CatalogPlaybackQueueItemProvider instance.

containers

public CatalogPlaybackQueueItemProvider.Builder containers(int containerType,
                                                           String... containerIds)

Creates a playback queue populated by item containers with the specified IDs, which will be in the order of their containers, followed by the order of the IDs, unless a shuffle mode is set.

Parameters:

containerType - The type of containers to fetch.

containerIds - The ids of the containers to fetch.

Returns:

This instance.

items

public CatalogPlaybackQueueItemProvider.Builder items(int itemType,
                                                      String... itemIds)

Creates a playback queue populated by items with the specified IDs, which will be in the order specified unless a shuffle mode is set.

Parameters:

itemType - The type of items to fetch.

itemIds - The ids of the items to fetch.

Returns:

This instance.

shuffleMode

public CatalogPlaybackQueueItemProvider.Builder shuffleMode(int shuffleMode)

Sets the desired playback shuffle mode for the playback queue.

Parameters:

shuffleMode - The desired playback shuffle mode.

Returns:

This instance.

startItemIndex

public CatalogPlaybackQueueItemProvider.Builder startItemIndex(int startItemIndex)

Starts playback from the specified index, rather than from the start of the playback queue.

Parameters:

startItemIndex - The index to start playback from.

Returns:

This instance.