Optional adsList of AdDescriptions to be queued for playback.
Optional analyticsList of AnalyticsDescriptions to configure analytics integrations for the media source.
Optional blockWhether the player should be blocked when an ad-related error occurs.
- A blocked player is not usable anymore. This has the same effect as invoking ChromelessPlayer.destroy.
false
Optional contentContent protection configuration.
Optional drmContent protection configuration.
Superseded by SourceConfiguration.contentProtection.
Optional manifestWhether segments in a HLS manifest should be represented by cues in a metadata text track.
Do not use this feature without consulting THEO Technologies.
Optional metadataChromecast metadata configuration.
- Available since v2.21.0.
Optional mutedThe muted autoplay policy.
- The muted autoplay policy is impacted by this property and PlayerConfiguration.mutedAutoplay.
'none'
Optional playIf set, only allow ads to play that are scheduled after this time.
- This setting is strictly after - e.g. setting playAdsAfterTime to 15 will cause the player to ignore an ad break scheduled to play at 15s.
- When scheduling a VMAP, it is required to set the AdSource type to vmap.
Optional posterThe poster of the media source.
- An empty string ('') clears the current poster.
- This poster has priority over ChromelessPlayer.poster.
Optional sourcesOne or more media resources for playback.
- Multiple media sources should be used to increase platform compatibility. See examples below for important use cases.
- The player will try each source in the provided order.
In this example, the player will first try to play the DASH source. This might fail if the browser does not support the Widevine or PlayReady CDM, for example on Safari. In that case, the player will try to play the HLS source instead.
[{
src: 'dash-source-with-drm.mpd'
contentProtection: {
widevine: {
licenseAcquisitionURL: 'https://license.company.com/wv'
},
playready: {
licenseAcquisitionURL: 'https://license.company.com/pr'
}
}
},{
src: 'hls-source-with-drm.m3u8',
contentProtection: {
fairplay: {
certificateURL: 'https://license.company.com/fp'
}
}
}]
In this example, the player will first try to play the DASH source. This might fail if the browser does not support the Media Source Extensions API. In that case, the player will try to play the MP4 source instead, though without features such as adaptive bitrate switching.
[{
src: 'source.mpd'
},{
src: 'source.mp4'
}]
Optional streamThe stream type.
- Available since 6.9.0.
- This is used as a hint for the player to show the correct UI while loading the stream,
for example to avoid showing a seek bar when the stream is known in advance to be live.
- This is required for live and DVR streams when casting to Chromecast,
in order for the Chromecast receiver to show the correct UI.
Optional textList of text tracks to be side-loaded with the media source.
- A source change will reset side-loaded text tracks.
Optional timeThe URL of a time server used by the player to synchronise the time in DASH sources.
- The time server should return time in ISO-8601 format.
- Overrides the time server provided the DASH manifest's <UTCTiming>.
- All sources will use the time server. Alternatively, for one source use BaseSource.timeServer.
Optional vrVirtual reality configuration.
Generated using TypeDoc
Describes the configuration of a player's source.