Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Config

Hierarchy

  • Config

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 cast

Google Cast configuration.

deprecated

Use remotecontrol with GoogleCastRemoteControlConfig instead.

Optional drm

The DRM object should be included in the source object.

deprecated

Optional events

events: EventConfig

A list of callback functions for events. Events can also be dynamically added and removed through PlayerAPI.addEventHandler and PlayerAPI.removeEventHandler.

Example:

events: {
  onReady: function(data) {
    console.log('version: ' + this.getVersion() + ', onReady Event data: ', data);
  },
  onPlay: function(data) {
    // do awesome stuff
  },
  onError: function(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 location

location: LocationConfig

This can be used to specify custom paths to bitmovinplayer.swf, 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

source

source: SourceConfig

Mandatory. Contains information to the video source, e.g. dash, hls, progressive fallback.

Optional style

UX/UI config settings.

Optional tweaks

tweaks: TweaksConfig

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

Generated using TypeDoc