cast.framework.messages. EditTracksInfoRequestData
Media event EDIT_TRACKS_INFO request data.
Constructor
EditTracksInfoRequestData
new EditTracksInfoRequestData()
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).