QueueUpdateRequestData

new QueueUpdateRequestData()

Extends

cast.framework.messages.RequestData

currentItemId

(number or undefined)

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.

Inherited from

cast.framework.messages.RequestData#customData

items

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

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.

Inherited from

cast.framework.messages.RequestData#mediaSessionId

repeatMode

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

Behavior of the queue when all items have been played.

requestId

number

Id of the request, used to correlate request/response.

Inherited from

cast.framework.messages.RequestData#requestId

sequenceNumber

(number or undefined)

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.

Inherited from

cast.framework.messages.RequestData#sequenceNumber

shuffle

(boolean or undefined)

Shuffle the queue items when the update is processed. After the queue items are shuffled, the item at the currentItem position will be loaded.