Class: RequestData

AI-generated Key Takeaways

• RequestData objects encapsulate data for media event requests within the Cast framework.

• These objects include details like request type, application-specific data, media session ID, request ID, and a sequence number for queue synchronization.

• The customData property allows for flexible extension of the media protocol by enabling the sender and receiver to exchange application-specific information.

• mediaSessionId, requestId, and sequenceNumber provide identifiers and context for managing and tracking media requests within a session.

cast.framework.messages.RequestData

class   static

Media event request data.

Constructor

RequestData

new RequestData(type)

Parameter
type	cast.framework.messages.MessageType Request type. Value must not be null.

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.

mediaSessionId

(number or undefined)

Id of the media session that the request applies to.

requestId

number

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

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.