Class: GetStatusRequestData

  • GetStatusRequestData is a class representing the data for a GET_STATUS request in the media event, extending cast.framework.messages.RequestData.

  • It includes properties like customData for application-specific data, mediaSessionId for the relevant media session, and options for request-specific configurations.

  • The requestId property correlates the request and its response, while sequenceNumber helps synchronize queue commands, both inherited from RequestData.

  • The options property specifically holds the settings for a GET_STATUS request, providing further control over the operation.

cast.framework.messages.GetStatusRequestData

class   static

Media event GET_STATUS request data.

Constructor

GetStatusRequestData

new GetStatusRequestData()

Extends
cast.framework.messages.RequestData

Properties

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

mediaSessionId

(number or undefined)

Id of the media session that the request applies to.

Inherited from
cast.framework.messages.RequestData#mediaSessionId

options

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

The options of a GET_STATUS request.

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