cast.framework.messages. QueueReorderRequestData
Media event queue REORDER request data.
Constructor
QueueReorderRequestData
new QueueReorderRequestData(itemIds)
Parameter |
|
|---|---|
|
itemIds |
Array of number The IDs of the items to reorder. Value must not be null. |
Properties
currentItemId
(number or undefined)
ID of the current media Item after the reorder (if not provided, the currentItem value will be the same as before the reorder).
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
insertBefore
(number or undefined)
ID of the item that will be located immediately after the reordered list. If the ID is not found or it is not provided, the reordered list will be appended at the end of the existing list.
itemIds
non-null Array of number
IDs of the items to be reordered, in the new order. Items not provided will keep their existing order. The provided list will be inserted at the position determined by insertBefore. For example:
If insertBefore is not specified Existing queue: “A”,”D”,”G”,”H”,”B”,”E” itemIds: “D”,”H”,”B” New Order: “A”,”G”,”E”,“D”,”H”,”B”
If insertBefore is “A” Existing queue: “A”,”D”,”G”,”H”,”B” itemIds: “D”,”H”,”B” New Order: “D”,”H”,”B”,“A”,”G”,”E”
If insertBefore is “G” Existing queue: “A”,”D”,”G”,”H”,”B” itemIds: “D”,”H”,”B” New Order: “A”,“D”,”H”,”B”,”G”,”E”
mediaSessionId
(number or undefined)
Id of the media session that the request applies to.
- Inherited from
- cast.framework.messages.RequestData#mediaSessionId
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