Class: QueueData

AI-generated Key Takeaways

• chrome.cast.media.QueueData is a class that defines the data structure for a media queue in the Google Cast SDK.

• It includes properties like id, name, description, repeatMode, items, startIndex, and startTime to control queue behavior.

• The items property holds an array of chrome.cast.media.QueueItem objects, representing the individual media items within the queue.

• QueueData allows developers to manage playback order, repetition, and starting position within a media queue on a Cast receiver.

• Additional metadata, such as containerMetadata and queueType, can provide further context about the queue's content and purpose.

chrome.cast.media.QueueData

class   static

Queue data as part of the LOAD request.

Constructor

QueueData

new QueueData(id, name, description, repeatMode, items, startIndex, startTime)

Parameter
id	Optional string ID of the queue.
name	Optional string Name of the queue.
description	Optional string Description of the queue.
repeatMode	Optional chrome.cast.media.RepeatMode How to repeat the queue. Value must not be null.
items	Optional Array of non-null chrome.cast.media.QueueItem The queue items associated with the queue which can often be omitted for a cloud queue or a receiver implemented queue. Value must not be null.
startIndex	Optional number The index of the item in the queue that should be used to start playback first.
startTime	Optional number Seconds (since the beginning of content) to start playback of the first item.

Properties

containerMetadata

(non-null chrome.cast.media.ContainerMetadata or undefined)

Metadata to describe the queue content, and optionally media sections.

description

(string or undefined)

Description of the queue.

entity

(string or undefined)

Optional Queue entity ID, provide Google Assistant deep link.

id

(string or undefined)

ID of the queue.

items

(non-null Array of non-null chrome.cast.media.QueueItem or undefined)

Array of queue items. It is sorted (first element will be played first).

name

(string or undefined)

Name of the queue.

queueType

(non-null chrome.cast.media.QueueType or undefined)

Queue type, e.g. album, playlist, radio station, tv series, etc.

repeatMode

(non-null chrome.cast.media.RepeatMode or undefined)

Continuous playback behavior of the queue.

shuffle

(boolean or undefined)

Indicate if the queue is shuffled.

startIndex

(number or undefined)

The index of the item in the queue that should be used to start playback first.

startTime

(number or undefined)

Seconds (since the beginning of content) to start playback of the first item.