ID of the current media Item after the changes (if not provided or not
found, the currentItem value will be the same as before the update).
currentTime
(number or undefined)
Seconds since the beginning of content to start playback of the current
item. If provided, this value will take precedence over the startTime
value provided at the QueueItem level but only the first time the item is
played. This is to cover the common case where the user jumps to the
middle of an item so the currentTime does not apply to the item
permanently like the QueueItem startTime does. It avoids having to reset
the startTime dynamically (that may not be possible if the phone has gone
to sleep).
customData
(non-null Object or undefined)
Application-specific data for this request. It enables the sender and
receiver to easily extend the media protocol without having to use a new
namespace with custom messages.
List of queue items to be updated. No reordering will happen, the items
will retain the existing order.
jump
(number or undefined)
Skip/Go back number of items with respect to the position of
currentItem (it can be negative). If it is out of boundaries, the
currentItem will be the next logical item in the queue wrapping around
the boundaries. The new currentItem position will follow the rules of the
queue repeat behavior.
mediaSessionId
(number or undefined)
Id of the media session that the request applies to.
A number to synchronize all queue commands.
If provided for a queue command, the SDK will verify the queue latest
sequence number match the request.
Current sequenceNumber is provided as part of outgoing queue changed
messages.
[[["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\u003eQueueUpdateRequestData\u003c/code\u003e is used to send requests for updating the media queue, such as changing the current item, playback time, or reordering items.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties for specifying the desired changes, like \u003ccode\u003ecurrentItemId\u003c/code\u003e, \u003ccode\u003ecurrentTime\u003c/code\u003e, \u003ccode\u003eitems\u003c/code\u003e, \u003ccode\u003erepeatMode\u003c/code\u003e, and \u003ccode\u003eshuffle\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ecustomData\u003c/code\u003e enables the sender and receiver to exchange application-specific information alongside the queue update request.\u003c/p\u003e\n"],["\u003cp\u003eThe request also includes properties for identification and synchronization, like \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003emediaSessionId\u003c/code\u003e, and \u003ccode\u003esequenceNumber\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this data structure to build robust media playback experiences with features like queue management, playback control, and custom application logic.\u003c/p\u003e\n"]]],["`QueueUpdateRequestData` manages updates to a media queue. Key actions include defining the `currentItemId`, adjusting `currentTime` for playback start, and using `customData` for extending the protocol. It allows updating `items` while retaining their order and setting the `repeatMode`. Additionally, it manages jumping/skipping with the `jump`, and shuffling the `items` with the option shuffle. It uses `requestId`, `mediaSessionId`, and `sequenceNumber` for synchronization.\n"],null,["cast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).QueueUpdateRequestData \nclass static\n\nMedia event UPDATE queue request data.\n\nConstructor\n\nQueueUpdateRequestData\n\nnew\nQueueUpdateRequestData()\n\nExtends\n: [cast.framework.messages.RequestData](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData)\n\nProperties\n\ncurrentItemId\n\n(number or undefined)\n\nID of the current media Item after the changes (if not provided or not\nfound, the currentItem value will be the same as before the update).\n\ncurrentTime\n\n(number or undefined)\n\nSeconds since the beginning of content to start playback of the current\nitem. If provided, this value will take precedence over the startTime\nvalue provided at the QueueItem level but only the first time the item is\nplayed. This is to cover the common case where the user jumps to the\nmiddle of an item so the currentTime does not apply to the item\npermanently like the QueueItem startTime does. It avoids having to reset\nthe startTime dynamically (that may not be possible if the phone has gone\nto sleep).\n\ncustomData\n\n(non-null Object or undefined)\n\nApplication-specific data for this request. It enables the sender and\nreceiver to easily extend the media protocol without having to use a new\nnamespace with custom messages.\n\nInherited from\n: [cast.framework.messages.RequestData#customData](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData#customData)\n\nitems\n\n(non-null Array of non-null [cast.framework.messages.QueueItem](/cast/docs/reference/web_receiver/cast.framework.messages.QueueItem) or undefined)\n\nList of queue items to be updated. No reordering will happen, the items\nwill retain the existing order.\n\njump\n\n(number or undefined)\n\nSkip/Go back number of items with respect to the position of currentItem (it can be negative). If it is out of boundaries, the currentItem will be the next logical item in the queue wrapping around the boundaries. The new currentItem position will follow the rules of the queue repeat behavior.\n\nmediaSessionId\n\n(number or undefined)\n\nId of the media session that the request applies to.\n\nInherited from\n: [cast.framework.messages.RequestData#mediaSessionId](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData#mediaSessionId)\n\nrepeatMode\n\n(non-null [cast.framework.messages.RepeatMode](/cast/docs/reference/web_receiver/cast.framework.messages#.RepeatMode) or undefined)\n\nBehavior of the queue when all items have been played.\n\nrequestId\n\nnumber\n\nId of the request, used to correlate request/response.\n\nInherited from\n: [cast.framework.messages.RequestData#requestId](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData#requestId)\n\nsequenceNumber\n\n(number or undefined)\n\nA number to synchronize all queue commands.\nIf provided for a queue command, the SDK will verify the queue latest\nsequence number match the request.\nCurrent sequenceNumber is provided as part of outgoing queue changed\nmessages.\n\nInherited from\n: [cast.framework.messages.RequestData#sequenceNumber](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData#sequenceNumber)\n\nshuffle\n\n(boolean or undefined)\n\nShuffle the queue items when the update is processed. After the queue\nitems are shuffled, the item at the currentItem position will be loaded."]]