Optional
adaptationConfigures the adaptation logic.
Optional
advertisingAllows you to define which ads you want to display and when you want to display them. In order to play ads on your website, you need to specify an ad config.
Optional
analyticsBundled Bitmovin Analytics Configuration used to specify metadata and other related info.
Can also be used to completely disable Analytics by setting this to false
in case the Analytics module is loaded, but Analytics is not desired.
Optional
bufferConfigures various buffer settings.
Optional
castGoogle Cast configuration.
Use remotecontrol with GoogleCastRemoteControlConfig instead.
Optional
eventsA list of callback functions for events. Events can also be dynamically added and removed through on and off.
Example:
events: {
[PlayerEvent.SourceLoaded]: data => {
console.log('version: ' + player.getVersion() + ', SourceLoaded Event data: ', data);
},
[PlayerEvent.Play]: data => {
// do awesome stuff
},
[PlayerEvent.Error]: data => {
console.error('An error occurred:', data);
}
}
Mandatory. A personal key can be found in the bitmovin portal and should be specified here. Do not forget to enter all your domains (subdomains are included) in your account.
Optional
licensingLicensing configuration.
Optional
liveProvide parameters specific to live streams.
For better flexibility it is also possible to define a LiveConfig
at source level.
Optional
locationThis can be used to specify custom paths to bitmovinplayer-core.min.js, and bitmovinplayer-core.min.css instead of having all files in the same folder.
Optional
logsCan be use to fine tune logging of the player.
Optional
networkNetwork configuration.
Optional
playbackPlayback config settings.
Optional
remotecontrolRemote control configuration (e.g. Chromecast)
7.1
Optional
storageAllows configuration of the player's access to the Web Storage API.
v8.91.0
Optional
styleUX/UI config settings.
Optional
tweaksTweaks. Use these values only if you know what you are doing.
Optional
uiUI configuration that is passed to the Bitmovin Player UI if the UI module is loaded. Can also be used to disable the UI in case the UI module is loaded but the UI is not desired.
The entry point to the player configuration is the PlayerConfig interface, which is passed into the constructor of the player. There are several ways to do this:
<source>
tag:Example configuration:
Example source: