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).
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eQueueItem\u003c/code\u003e objects represent items within a media queue, holding information like media metadata, playback settings, and custom data.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create \u003ccode\u003eQueueItem\u003c/code\u003e instances to insert elements into the queue, but should omit the \u003ccode\u003eitemId\u003c/code\u003e for new items to avoid conflicts.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of a \u003ccode\u003eQueueItem\u003c/code\u003e include \u003ccode\u003emedia\u003c/code\u003e for content details, \u003ccode\u003eautoplay\u003c/code\u003e and \u003ccode\u003estartTime\u003c/code\u003e for playback control, and \u003ccode\u003epreloadTime\u003c/code\u003e to optimize transitions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecustomData\u003c/code\u003e property allows developers to attach application-specific information to queue items for extended functionality.\u003c/p\u003e\n"],["\u003cp\u003eExisting queue items can be identified and managed using their unique \u003ccode\u003eitemId\u003c/code\u003e, assigned by the receiver upon insertion.\u003c/p\u003e\n"]]],["`QueueItem` stores queue element information. Developers create it for inserting queue elements, omitting `itemId` to prevent collisions. Key properties include: `activeTrackIds` (active track IDs), `autoplay` (automatic playback), `customData` (extra data), `media` (metadata), `orderId` (original order), `preloadTime` (preloading hint), and `startTime` (content start time). `itemId` is assigned by the receiver during creation/insertion, and `preloadTime` helps smooth transitions between queued items.\n"],null,["cast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).QueueItem \nclass static\n\nQueue item information. Application developers may need to create a QueueItem\nto insert a queue element using\ncast.framework.messages.InsertQueueItems. In this case they should\nnot provide an itemId (as the actual itemId will be assigned when the item is\ninserted in the queue). This prevents ID collisions with items added from a\nsender app.\n\nConstructor\n\nQueueItem\n\nnew\nQueueItem(opt_itemId)\n\n| Parameter ||\n|------------|------------------------------|\n| opt_itemId | Optional number The item ID. |\n\nProperties\n\nactiveTrackIds\n\n(non-null Array of number or undefined)\n\nArray of Track trackIds that are active. If the array is not provided,\nthe default tracks will be active.\n\nautoplay\n\n(boolean or undefined)\n\nIf the autoplay parameter is not specified or is true, the media player\nwill begin playing the element in the queue when the item becomes the\ncurrentItem.\n\ncustomData\n\n(nullable Object or undefined)\n\nThe application can define any extra queue item information needed.\n\nitemId\n\n(number or undefined)\n\nUnique identifier of the item in the queue. The attribute is optional\nbecause for LOAD or INSERT should not be provided (as it will be assigned\nby the receiver when an item is first created/inserted).\n\nmedia\n\n(non-null [cast.framework.messages.MediaInformation](/cast/docs/reference/web_receiver/cast.framework.messages.MediaInformation) or undefined)\n\nMetadata (including contentId) of the playlist element.\n\norderId\n\n(number or undefined)\n\nUsed to track original order of an item in the queue to undo shuffle.\n\npreloadTime\n\n(number or undefined)\n\nThis parameter is a hint for the receiver to preload this media item\nbefore it is played. It allows for a smooth transition between items\nplayed from the queue. The time is expressed in seconds, relative to the\nbeginning of this item playback (usually the end of the previous item\nplayback). For example, if the value is 10 seconds, this item will be\npreloaded 10 seconds before the previous item has finished. The receiver\nwill try to honor this value but will not guarantee it, for example if\nthe value is larger than the previous item duration the receiver may just\npreload this item shortly after the previous item has started playing\n(there will never be two items being preloaded in parallel). Also, if an\nitem is inserted in the queue just after the currentItem and the time to\npreload is higher than the time left on the currentItem, the preload will\njust happen as soon as possible. Negative values explicitly disable\npreloading. If the value is 0 or undefined, the media item will start to\npreload as soon as the previous item is fully downloaded after its\nplayback position.\n\nstartTime\n\n(number or undefined)\n\nSeconds since beginning of content. If the content is live content, and\nstartTime is not specified, the stream will start at the live position."]]