Configuration

The Player and its plugins have a range of configuration options to customize the experience and functionality, see each section below for the configuration option type documentation.

Player

PixellotPlayerOptions

// an example configuration
new Player(container, {
    autoplay: true,
    controls: true,
    experimentalPixellotSecuredSrc: true,
    analytics: {
      youboraAccountCode: 'pixellotdev'
    },
    tags: {
      data: [
        {
          "id": 1,
          "startTime": 10
        },
        {
          "id": 2,
          "startTime": 300,
          "type": "basketball_assist"
        },
        {
          "id": 3,
          "startTime": 60,
          "type": "basketball_alley_oop"
        },
        {
          "id": 4,
          "startTime": 100,
          "type": "dot"
        }
      ],
      iconBaseUrl: 'https://pixellot-web-sdk.pixellot.tv/v3' // this is the default value that will be used if omitted
    },
})

analytics

PlayerAnalyticsOptions

hd

PixellotPlayerConfigHD

metadata

PlayerMetadata

pano

PixellotPlayerConfigPano

source

PlayerSource

tags

TagsConfig

Notable Configs

• iconBaseUrl should be configured to point to the URL that the Tag icons are hosted. This URL will be used if the tag data items themselves don't have an iconUrl configured. If omitted it will default to https://pixellot-web-sdk.pixellot.tv/v3.