Class: LoadRequestData

Constructor

LoadRequestData

new LoadRequestData()

Extends
cast.framework.messages.RequestData

Properties

activeTrackIds

(non-null Array of number or undefined)

Array of trackIds that are active. If the array is not provided, the default tracks will be active.

autoplay

(boolean or undefined)

If the autoplay parameter is specified, the media player will begin playing the content when it is loaded. Even if autoplay is not specified,the media player implementation may choose to begin playback immediately.

credentials

(string or undefined)

Optional user credentials.

credentialsType

(string or undefined)

Optional credentials type. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

currentTime

(number or undefined)

Seconds since beginning of content. If the content is live content, and currentTime is not specified, the stream will start at the live position.

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

loadOptions

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

Added load options.

media

non-null cast.framework.messages.MediaInformation

The media information associated with the load request.

mediaSessionId

(number or undefined)

Id of the media session that the request applies to.

Inherited from
cast.framework.messages.RequestData#mediaSessionId

playbackRate

(number or undefined)

The media playback rate.

queueData

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

Queue data.

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