Optional
adsList of AdDescriptions to be queued for playback.
Optional
analyticsList of AnalyticsDescriptions to configure source-related properties for analytics connectors.
Optional
contentContent protection configuration.
Optional
metadataDescribes the metadata of a source.
Optional
posterThe poster of the media source.
- An empty string (''
) clears the current 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
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.
Generated using TypeDoc
Describes the configuration of a player's source.