org.digitalmediaserver.cast

Class QueueItem

java.lang.Object

org.digitalmediaserver.cast.QueueItem

@Immutable
public class QueueItem
extends Object

Queue item information.

Application developers may need to create a QueueItem to insert a queue element. In this case they should not provide an itemId (as the actual itemId will be assigned when the item is inserted in the queue). This prevents ID collisions with items added from a sender application.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	activeTrackIds List of Track trackIds that are active.
protected Boolean	autoplay If the autoplay parameter is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.
protected Map<String,Object>	customData The application can define any extra queue item information needed
protected Integer	itemId Unique identifier of the item in the queue.
protected Media	media Metadata (including contentId) of the playlist element
protected Integer	orderId Used to track original order of an item in the queue to undo shuffle
protected Double	preloadTime This parameter is a hint for the receiver to preload this media item before it is played.
protected Double	startTime Seconds since beginning of content.

Constructor Summary

Constructors

Constructor and Description
QueueItem(List<Integer> activeTrackIds, Boolean autoplay, Map<String,Object> customData, Integer itemId, Media media, Integer orderId, Double preloadTime, Double startTime) Creates a new instance using the specified parameters.
QueueItem(List<Integer> activeTrackIds, Boolean autoplay, Media media, Double preloadTime, Double startTime) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Integer>	getActiveTrackIds()
Boolean	getAutoplay() If the autoplay parameter is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.
Map<String,Object>	getCustomData() The application can define any extra queue item information needed.
Integer	getItemId() The item ID is a unique identifier of the item in the queue.
Media	getMedia()
Integer	getOrderId()
Double	getPreloadTime() This parameter is a hint for the receiver to preload this media item before it is played.
Double	getStartTime()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

activeTrackIds

@Nonnull
protected final List<Integer> activeTrackIds

List of Track trackIds that are active. If the list is not provided, the default tracks will be active.

autoplay

@Nullable
protected final Boolean autoplay

If the autoplay parameter is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.

customData

@Nonnull
protected final Map<String,Object> customData

The application can define any extra queue item information needed

itemId

@Nullable
protected final Integer itemId

Unique identifier of the item in the queue. The attribute is optional because for LOAD or INSERT should not be provided (as it will be assigned by the receiver when an item is first created/inserted).

media

@Nullable
protected final Media media

Metadata (including contentId) of the playlist element

orderId

@Nullable
protected final Integer orderId

Used to track original order of an item in the queue to undo shuffle

preloadTime

@Nullable
protected final Double preloadTime

This parameter is a hint for the receiver to preload this media item before it is played. It allows for a smooth transition between items played from the queue. The time is expressed in seconds, relative to the beginning of this item playback (usually the end of the previous item playback). Only positive values are valid. For example, if the value is 10 seconds, this item will be preloaded 10 seconds before the previous item has finished. The receiver will try to honor this value but will not guarantee it, for example if the value is larger than the previous item duration the receiver may just preload this item shortly after the previous item has started playing (there will never be two items being preloaded in parallel). Also, if an item is inserted in the queue just after the currentItem and the time to preload is higher than the time left on the currentItem, the preload will just happen as soon as possible.

startTime

@Nullable
protected final Double startTime

Seconds since beginning of content. If the content is live content, and startTime is not specified, the stream will start at the live position.

Constructor Detail

QueueItem

public QueueItem(@Nullable
                 List<Integer> activeTrackIds,
                 @Nullable
                 Boolean autoplay,
                 @Nullable
                 Media media,
                 @Nullable
                 Double preloadTime,
                 @Nullable
                 Double startTime)

Creates a new instance using the specified parameters.

Parameters:

activeTrackIds - the List of Track trackIds that are active. If the list is not provided, the default tracks will be active.

autoplay - the autoplay parameter, which if is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.

media - the Media instance of the playlist element.

preloadTime - the preload time in seconds.

startTime - the number of seconds since beginning of the content. If the content is live content, and startTime is not specified, the stream will start at the live position.

QueueItem

public QueueItem(@Nullable
                 List<Integer> activeTrackIds,
                 @Nullable
                 Boolean autoplay,
                 @Nullable
                 Map<String,Object> customData,
                 @Nullable
                 Integer itemId,
                 @Nullable
                 Media media,
                 @Nullable
                 Integer orderId,
                 @Nullable
                 Double preloadTime,
                 @Nullable
                 Double startTime)

Creates a new instance using the specified parameters.

Parameters:

activeTrackIds - the List of Track trackIds that are active. If the list is not provided, the default tracks will be active.

autoplay - the autoplay parameter, which if is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.

customData - the extra queue item information.

itemId - the item ID, which is a unique identifier of the item in the queue. The attribute is optional because for LOAD or INSERT should not be provided (as it will be assigned by the receiver when an item is first created/inserted).

media - the Media instance of the playlist element.

orderId - the order ID, which is used to track the original order of an item in the queue to undo shuffle.

preloadTime - the preload time in seconds.

startTime - the number of seconds since beginning of the content. If the content is live content, and startTime is not specified, the stream will start at the live position.

Method Detail

getActiveTrackIds

@Nonnull
public List<Integer> getActiveTrackIds()

Returns:

The List of Track trackIds that are active. If the list is not provided, the default tracks will be active.

getAutoplay

@Nullable
public Boolean getAutoplay()

If the autoplay parameter is not specified or is true, the media player will begin playing the element in the queue when the item becomes the currentItem.

Returns:

The autoplay status.

getCustomData

@Nonnull
public Map<String,Object> getCustomData()

The application can define any extra queue item information needed.

Returns:

The extra queue item information.

getItemId

@Nullable
public Integer getItemId()

The item ID is a unique identifier of the item in the queue. The attribute is optional because for LOAD or INSERT should not be provided (as it will be assigned by the receiver when an item is first created/inserted).

Returns:

The item ID.

getMedia

@Nullable
public Media getMedia()

Returns:

The Media instance of the playlist element.

getOrderId

@Nullable
public Integer getOrderId()

Returns:

The order ID, which is used to track the original order of an item in the queue to undo shuffle.

getPreloadTime

@Nullable
public Double getPreloadTime()

This parameter is a hint for the receiver to preload this media item before it is played. It allows for a smooth transition between items played from the queue. The time is expressed in seconds, relative to the beginning of this item playback (usually the end of the previous item playback). Only positive values are valid. For example, if the value is 10 seconds, this item will be preloaded 10 seconds before the previous item has finished. The receiver will try to honor this value but will not guarantee it, for example if the value is larger than the previous item duration the receiver may just preload this item shortly after the previous item has started playing (there will never be two items being preloaded in parallel). Also, if an item is inserted in the queue just after the currentItem and the time to preload is higher than the time left on the currentItem, the preload will just happen as soon as possible.

Returns:

The preload time in seconds.

getStartTime

@Nullable
public Double getStartTime()

Returns:

The number of seconds since beginning of the content. If the content is live content, and startTime is not specified, the stream will start at the live position.

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