Class: EditTracksInfoRequestData

  • EditTracksInfoRequestData is a class used for media event requests to edit track information, such as active tracks and text track settings.

  • It includes properties like activeTrackIds, language, and textTrackStyle to specify desired track modifications.

  • The request data can also include customData for application-specific needs and mediaSessionId to target a specific media session.

  • enableTextTracks can be used to enable or disable text tracks, while isSuggestedLanguage helps the receiver app differentiate between user specified or inferred language.

  • This class inherits properties like requestId, sequenceNumber, and customData from the cast.framework.messages.RequestData parent class.

cast.framework.messages.EditTracksInfoRequestData

class   static

Media event EDIT_TRACKS_INFO request data.

Constructor

EditTracksInfoRequestData

new EditTracksInfoRequestData()

Extends
cast.framework.messages.RequestData

Properties

activeTrackIds

(non-null Array of number or undefined)

Array of the Track trackIds that should be active. If it is not provided, the active tracks will not change. If the array is empty, no track will be active.

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

enableTextTracks

(boolean or undefined)

Flag to enable or disable text tracks. If false it will disable all text tracks, if true it will enable the first text track, or the previous active text tracks. This flag is ignored if activeTrackIds or language is provided.

isSuggestedLanguage

(boolean or undefined)

Indicates that the provided language was not explicit user request, but rather inferred from used language in voice query. It allows receiver apps to use user saved preference instead of spoken language.

language

(string or undefined)

Language for the tracks that should be active. The language field will take precedence over activeTrackIds if both are specified.

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

textTrackStyle

(cast.framework.messages.TextTrackStyle or undefined)

The requested text track style. If it is not provided the existing style will be used (if no style was provided in previous calls, it will be the default receiver style).