The algorithm for selection of the next item when the current item has
ended.
Default value
chrome.cast.media.RepeatMode.OFF
startIndex
number
The index of the item in the items array that must be the first
currentItem (the item that will be played first). Note this is the index
of the array (starts at 0) and not the itemId (as it is not known until
the queue is created). If repeatMode is chrome.cast.media.RepeatMode.OFF
playback will end when the last item in the array is played (elements
before the startIndex will not be played). This may be useful for
continuation scenarios where the user was already using the sender app
and in the middle decides to cast. In this way the sender app does not
need to map between the local and remote queue positions or saves one
extra request to update the queue.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003eQueueLoadRequest\u003c/code\u003e is used to load and potentially start playing a new, ordered list of media items on a Cast receiver.\u003c/p\u003e\n"],["\u003cp\u003eIt requires an array of \u003ccode\u003eQueueItem\u003c/code\u003e objects, specifying the media to be loaded and played.\u003c/p\u003e\n"],["\u003cp\u003eOptions for playback behavior include \u003ccode\u003ecustomData\u003c/code\u003e, \u003ccode\u003erepeatMode\u003c/code\u003e, and \u003ccode\u003estartIndex\u003c/code\u003e for controlling how the queue is handled.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erepeatMode\u003c/code\u003e determines how the queue behaves after the last item is played (e.g., repeating the queue, repeating a single item, or stopping).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003estartIndex\u003c/code\u003e allows you to specify which item in the queue should be played first, useful for resuming playback from a specific point.\u003c/p\u003e\n"]]],["The `QueueLoadRequest` class manages loading and playing an ordered list of media items. It requires a non-empty array of `QueueItem` objects. Key properties include `items` (the media list), `repeatMode` (playback behavior after an item ends), `startIndex` (specifying the first item to play by its index), and `customData` (for receiver app customization). `startIndex` defaults to 0, and `repeatMode` defaults to OFF. The provided array is sorted by index.\n"],null,["# Class: QueueLoadRequest\n\nchrome.[cast](/cast/docs/reference/web_sender/chrome.cast).[media](/cast/docs/reference/web_sender/chrome.cast.media).QueueLoadRequest\n======================================================================================================================================\n\nclass static\n\nA request to load and optionally start playback of a new ordered list of\nmedia items.\n\nConstructor\n-----------\n\n### QueueLoadRequest\n\nnew\nQueueLoadRequest(items)\n\n| #### Parameter ||\n|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| items | Array of non-null [chrome.cast.media.QueueItem](/cast/docs/reference/web_sender/chrome.cast.media.QueueItem) The list of media items to load. Must not be null or empty. Value must not be null. |\n\nProperties\n----------\n\n### customData\n\nnullable Object\n\nCustom data for the receiver application.\n\n### items\n\nnon-null Array of non-null [chrome.cast.media.QueueItem](/cast/docs/reference/web_sender/chrome.cast.media.QueueItem)\n\nArray of items to load. It is sorted (first element will be played\nfirst). Must not be null or empty.\n\n### repeatMode\n\nnon-null [chrome.cast.media.RepeatMode](/cast/docs/reference/web_sender/chrome.cast.media#.RepeatMode)\n\nThe algorithm for selection of the next item when the current item has\nended.\n\nDefault value\n: chrome.cast.media.RepeatMode.OFF\n\n### startIndex\n\nnumber\n\nThe index of the item in the items array that must be the first\ncurrentItem (the item that will be played first). Note this is the index\nof the array (starts at 0) and not the itemId (as it is not known until\nthe queue is created). If repeatMode is chrome.cast.media.RepeatMode.OFF\nplayback will end when the last item in the array is played (elements\nbefore the startIndex will not be played). This may be useful for\ncontinuation scenarios where the user was already using the sender app\nand in the middle decides to cast. In this way the sender app does not\nneed to map between the local and remote queue positions or saves one\nextra request to update the queue.\n\nDefault value\n: 0"]]