List of queue items.
The itemId field of the items should be empty or the request will fail
with an INVALID_PARAMS error. It is sorted (first element will be
played
first).
ID of the current media Item after the insertion (if not provided, the
currentItem value will be the same as before the insertion).
currentItemIndex
(number or undefined)
Index (relative to the items array, starting with 0) of the new current
media Item. For inserted items we use the index (similar to startIndex in
QUEUE_LOAD) and not currentItemId, because the itemId is unknown until
the items are inserted. If not provided, the currentItem value will be
the same as before the insertion (unless currentItemId is provided).
This param allows to make atomic the common use case of insert and play
an item.
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.
ID of the item that will be located immediately after the inserted list.
If the ID is not found or it is not provided, the list will be appended
at the end of the existing list.
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\u003eQueueInsertRequestData\u003c/code\u003e is used to request insertion of media items into the queue.\u003c/p\u003e\n"],["\u003cp\u003eIt provides parameters to specify the items to be inserted, their position in the queue, and playback behavior.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eitems\u003c/code\u003e field is mandatory and contains an array of \u003ccode\u003eQueueItem\u003c/code\u003e objects representing the media to be inserted.\u003c/p\u003e\n"],["\u003cp\u003eProperties such as \u003ccode\u003ecurrentItemId\u003c/code\u003e, \u003ccode\u003ecurrentItemIndex\u003c/code\u003e, and \u003ccode\u003ecurrentTime\u003c/code\u003e allow for controlling playback after insertion.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003einsertBefore\u003c/code\u003e enables specifying the insertion point within the existing queue.\u003c/p\u003e\n"]]],[],null,["# Class: QueueInsertRequestData\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).[messages](/cast/docs/reference/web_receiver/cast.framework.messages).QueueInsertRequestData\n===============================================================================================================================================================\n\nclass static\n\nMedia event queue INSERT request data.\n\nConstructor\n-----------\n\n### QueueInsertRequestData\n\nnew\nQueueInsertRequestData(items)\n\n| #### Parameter ||\n|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| items | Array of non-null [cast.framework.messages.QueueItem](/cast/docs/reference/web_receiver/cast.framework.messages.QueueItem) List of queue items. The itemId field of the items should be empty or the request will fail with an INVALID_PARAMS error. It is sorted (first element will be played first). Value must not be null. |\n\nExtends\n: [cast.framework.messages.RequestData](/cast/docs/reference/web_receiver/cast.framework.messages.RequestData)\n\nProperties\n----------\n\n### currentItemId\n\n(number or undefined)\n\nID of the current media Item after the insertion (if not provided, the\ncurrentItem value will be the same as before the insertion).\n\n### currentItemIndex\n\n(number or undefined)\n\nIndex (relative to the items array, starting with 0) of the new current\nmedia Item. For inserted items we use the index (similar to startIndex in\nQUEUE_LOAD) and not currentItemId, because the itemId is unknown until\nthe items are inserted. If not provided, the currentItem value will be\nthe same as before the insertion (unless currentItemId is provided).\nThis param allows to make atomic the common use case of insert and play\nan item.\n\n### currentTime\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\n### customData\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\n### insertBefore\n\n(number or undefined)\n\nID of the item that will be located immediately after the inserted list.\nIf the ID is not found or it is not provided, the list will be appended\nat the end of the existing list.\n\n### items\n\nnon-null Array of non-null [cast.framework.messages.QueueItem](/cast/docs/reference/web_receiver/cast.framework.messages.QueueItem)\n\nList of queue items. The itemId field of the items should be empty. It is\nsorted (first element will be played first).\n\n### mediaSessionId\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\n### requestId\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\n### sequenceNumber\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)"]]