cast.framework.messages. QueueItem
Queue item information. Application developers may need to create a QueueItem to insert a queue element using cast.framework.messages.InsertQueueItems. 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 app.
Constructor
QueueItem
new QueueItem(opt_itemId)
Parameter |
|
|---|---|
|
opt_itemId |
Optional number The item ID. |
Properties
activeTrackIds
(non-null Array of number or undefined)
Array of Track trackIds that are active. If the array is not provided, the default tracks will be active.
autoplay
(boolean or undefined)
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
(nullable Object or undefined)
The application can define any extra queue item information needed.
itemId
(number or undefined)
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
(non-null cast.framework.messages.MediaInformation or undefined)
Metadata (including contentId) of the playlist element.
orderId
(number or undefined)
Used to track original order of an item in the queue to undo shuffle.
preloadTime
(number or undefined)
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). 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. Negative values explicitly disable preloading. If the value is 0 or undefined, the media item will start to preload as soon as the previous item is fully downloaded after its playback position.
startTime
(number or undefined)
Seconds since beginning of content. If the content is live content, and startTime is not specified, the stream will start at the live position.