Class: QueueData

cast.framework.messages.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

The ID of the queue.

name

Optional

string

The name of the queue.

description

Optional

string

The description of the queue.

repeatMode

Optional

cast.framework.messages.RepeatMode

How to repeat the queue.

Value must not be null.

items

Optional

Array of non-null cast.framework.messages.QueueItem

The queue items associated with the queue. This may be omitted for a cloud queue or a receiver-implemented queue. Partners can omit the items parameter if they implement a cloud queue, which entails dynamically providing items upon request from the receiver. This is opposed to the approach where all the queue items are provided at the beginning of a media session. See https://developers.google.com/cast/docs/web_receiver/queueing for examples of regular queues and cloud queues.

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

The number of seconds (since the beginning of content) to start playback of the first item.

Properties

containerMetadata

(non-null cast.framework.messages.ContainerMetadata or undefined)

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

description

(string or undefined)

The description of the queue.

entity

(string or undefined)

An optional Queue entity ID, providing a Google Assistant deep link.

id

(string or undefined)

The ID of the queue.

items

(non-null Array of non-null cast.framework.messages.QueueItem or undefined)

An Array of queue items, sorted in playback order.

name

(string or undefined)

The name of the queue.

queueType

(non-null cast.framework.messages.QueueType or undefined)

A queue type, such as album, playlist, radio station, or tv series.

repeatMode

(non-null cast.framework.messages.RepeatMode or undefined)

The continuous playback behavior of the queue.

shuffle

(boolean or undefined)

true indicates that 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)

When to start playback of the first item, expressed as the number of seconds since the beginning of the media.