Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlayerConfig

Hierarchy

  • PlayerConfig

Index

Properties

Optional adaptation

Configures the adaptation logic.

Optional advertising

advertising: AdvertisingConfig

Allows 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 analytics

analytics: AnalyticsConfig

Bundled Bitmovin Analytics Configuration used to specify metadata and other related info.

Optional buffer

buffer: BufferConfig

Configures various buffer settings.

Optional cast

Google Cast configuration.

deprecated

Use remotecontrol with GoogleCastRemoteControlConfig instead.

Optional events

events: EventConfig

A list of callback functions for events. Events can also be dynamically added and removed through PlayerAPI.on and PlayerAPI.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);
  }
}

key

key: string

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 licensing

licensing: LicensingConfig

Licensing configuration.

Optional live

Provide parameters specific to live streams

Optional location

location: LocationConfig

This 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 logs

Can be use to fine tune logging of the player.

Optional network

network: NetworkConfig

Network configuration.

Optional playback

playback: PlaybackConfig

Playback config settings.

Optional remotecontrol

Remote control configuration (e.g. Chromecast)

since

7.1

Optional style

UX/UI config settings.

Optional tweaks

tweaks: TweaksConfig

Tweaks. Use these values only if you know what you are doing.

Optional ui

ui: UIConfig | false

UI 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.

Generated using TypeDoc