Class: VolumeRequestData

  • VolumeRequestData is used for SET_VOLUME media event requests, allowing senders to adjust the volume on the receiver.

  • It inherits properties like requestId, mediaSessionId, and customData from RequestData for request management and application-specific data.

  • The volume property is a crucial part of this request, specifying the desired volume level using a cast.framework.messages.Volume object.

  • Developers can leverage sequenceNumber to synchronize queue commands and ensure consistency in handling media playback requests.

cast.framework.messages.VolumeRequestData

class   static

Media event SET_VOLUME request data.

Constructor

VolumeRequestData

new VolumeRequestData()

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

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

volume

non-null cast.framework.messages.Volume

The media stream volume.