Class: RequestData

  • cast.framework.messages.RequestData is a static class representing media event request data.

  • It has a constructor that takes a required type parameter of type cast.framework.messages.MessageType.

  • The class has properties for custom data, media session ID, request ID, and an optional sequence number for synchronizing queue commands.

  • The requestId property is used to correlate requests and responses.

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.