Constructor

CastReceiverOptions

new CastReceiverOptions()

Properties

customNamespaces

non-null Object with non-null cast.framework.system.MessageType properties

Optional map of custom messages namespaces to initialize and their types. Custom messages namespaces need to be initiated before the application started, so it is best to provide the namespaces in the receiver options. (The default type of a message bus is JSON, if not provided here).

localSenderId

(string or undefined)

Sender id used for local requests. Default value is 'local'.

maxInactivity

(number or undefined)

Maximum time in seconds before closing an idle sender connection. Setting this value enables a heartbeat message to keep the connection alive. Used to detect unresponsive senders faster than typical TCP timeouts. The minimum value is 5 seconds, there is no upper bound enforced but practically it's minutes before platform TCP timeouts come into play. Default value is 10 seconds.

mediaElement

(non-null HTMLMediaElement or undefined)

Optional media element to play content with. Default behavior is to use the first found media element in the page.

playbackConfig

(non-null cast.framework.PlaybackConfig or undefined)

Optional playback configuration.

playWatchedBreak

(boolean or undefined)

If this is true, the watched client stitching break will also be played.

preferredPlaybackRate

(number or undefined)

Preferred value for player playback rate. It is used if playback rate value is not provided in the load request.

preferredTextLanguage

(string or undefined)

Preferred text track language. It is used if no active track is provided in the load request.

queue

(non-null cast.framework.QueueBase or undefined)

Optional queue implementation.

statusText

(string or undefined)

Text that represents the application status. It should meet internationalization rules as may be displayed by the sender application.

supportedCommands

(number or undefined)

A bitmask of media commands supported by the application. LOAD, PLAY, STOP, GET_STATUS must always be supported. If this value is not provided, then PAUSE, SEEK, STREAM_VOLUME, STREAM_MUTE are assumed to be supported too.

See also
cast.framework.message.Command

uiConfig

(non-null cast.framework.ui.UiConfig or undefined)

UI Configuration.

useLegacyDashSupport

(boolean or undefined)

Indicate that MPL should be used for DASH content.

versionCode

(number or undefined)

An integer used as an internal version number. This number is used only to distinguish between receiver releases and higher numbers do not necessarily have to represent newer releases.