org.digitalmediaserver.cast

Class QueueData

java.lang.Object

org.digitalmediaserver.cast.QueueData

@Immutable
public class QueueData
extends Object

Queue data as part of the LOAD request.

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueData.QueueType Types of media container/queue.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContainerMetadata	containerMetadata Metadata to describe the queue content, and optionally media sections
protected String	description Description of the queue
protected String	entity Optional Queue entity ID, provide Google Assistant deep link
protected String	id ID of the queue
protected List<QueueItem>	items List of queue items.
protected String	name Name of the queue
protected QueueData.QueueType	queueType Queue type, e.g. album, playlist, radio station, tv series, etc.
protected MediaStatus.RepeatMode	repeatMode Continuous playback behavior of the queue
protected Boolean	shuffle Indicate if the queue is shuffled
protected Integer	startIndex The index of the item in the queue that should be used to start playback first
protected Double	startTime Seconds (since the beginning of content) to start playback of the first item

Constructor Summary

Constructors

Constructor and Description
QueueData(ContainerMetadata containerMetadata, String description, String entity, String id, List<QueueItem> items, String name, QueueData.QueueType queueType, MediaStatus.RepeatMode repeatMode, Boolean shuffle, Integer startIndex, Double startTime) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ContainerMetadata	getContainerMetadata()
String	getDescription()
String	getEntity()
String	getId()
List<QueueItem>	getItems()
String	getName()
QueueData.QueueType	getQueueType()
MediaStatus.RepeatMode	getRepeatMode()
Boolean	getShuffle()
Integer	getStartIndex()
Double	getStartTime()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

containerMetadata

@Nullable
protected final ContainerMetadata containerMetadata

Metadata to describe the queue content, and optionally media sections

description

@Nullable
protected final String description

Description of the queue

entity

@Nullable
protected final String entity

Optional Queue entity ID, provide Google Assistant deep link

id

@Nullable
protected final String id

ID of the queue

items

@Nonnull
protected final List<QueueItem> items

List of queue items. It is sorted (first element will be played first).

name

@Nullable
protected final String name

Name of the queue

queueType

@Nullable
protected final QueueData.QueueType queueType

Queue type, e.g. album, playlist, radio station, tv series, etc.

repeatMode

@Nullable
protected final MediaStatus.RepeatMode repeatMode

Continuous playback behavior of the queue

shuffle

@Nullable
protected final Boolean shuffle

Indicate if the queue is shuffled

startIndex

@Nullable
protected final Integer startIndex

The index of the item in the queue that should be used to start playback first

startTime

@Nullable
protected final Double startTime

Seconds (since the beginning of content) to start playback of the first item

Constructor Detail

QueueData

public QueueData(ContainerMetadata containerMetadata,
                 String description,
                 String entity,
                 String id,
                 List<QueueItem> items,
                 String name,
                 QueueData.QueueType queueType,
                 MediaStatus.RepeatMode repeatMode,
                 Boolean shuffle,
                 Integer startIndex,
                 Double startTime)

Creates a new instance using the specified parameters.

Parameters:

containerMetadata - the metadata to describe the queue content.

description - the description of the queue.

entity - the optional queue entity ID, provide Google Assistant deep link.

id - the ID of the queue.

items - the List of QueueItems. It is sorted (first element will be played first).

name - the name of the queue.

queueType - the queue type, e.g. album, playlist, radio station, tv series, etc.

repeatMode - the continuous playback behavior of the queue.

shuffle - true if the queue is shuffled, false otherwise.

startIndex - the index of the item in the queue that should be used to start playback first.

startTime - the seconds (since the beginning of content) to start playback of the first item.

Method Detail

getContainerMetadata

@Nullable
public ContainerMetadata getContainerMetadata()

Returns:

The metadata to describe the queue content.

getDescription

@Nullable
public String getDescription()

Returns:

The description of the queue.

getEntity

@Nullable
public String getEntity()

Returns:

The optional queue entity ID, provide Google Assistant deep link.

getId

@Nullable
public String getId()

Returns:

The ID of the queue.

getItems

@Nonnull
public List<QueueItem> getItems()

Returns:

The List of QueueItems. It is sorted (first element will be played first).

getName

@Nullable
public String getName()

Returns:

The name of the queue.

getQueueType

@Nullable
public QueueData.QueueType getQueueType()

Returns:

The queue type, e.g. album, playlist, radio station, tv series, etc.

getRepeatMode

@Nullable
public MediaStatus.RepeatMode getRepeatMode()

Returns:

The continuous playback behavior of the queue.

getShuffle

@Nullable
public Boolean getShuffle()

Returns:

true if the queue is shuffled, false otherwise.

getStartIndex

@Nullable
public Integer getStartIndex()

Returns:

The index of the item in the queue that should be used to start playback first.

getStartTime

@Nullable
public Double getStartTime()

Returns:

The seconds (since the beginning of content) to start playback of the first item.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object