Brightcove Plugin

The standard tracker can automatically detect and track Brightcove videos that are embedded directly on the tracked page as <video> elements. However, by installing the Brightcove plugin, you can also track Brightcove videos embedded with <iframe> elements or inserted via the Brightcove Accelerated Mobile Pages (AMP) component.

Getting Started

Contact us first

Proper activation of the Brightcove plugin requires changes to your configuration. Please contact your account manager before starting the installation process below.

For general information on how to install and configure plugins, see Brightcove's documentation.

  1. Choose a player from your Brightcove studio dashboard to edit.
  2. Find the "Plugin" panel on the player page, and click "Edit".
  3. Click "JavaScript" to expand that section, and paste the link to the current version of the plugin:
  4. Click to expand the "Name, Options (JSON)" section.

    1. Set the "Plugin Name" to parsely.
    2. Add plugin options as described below.
  5. Save changes.
  6. Republish player.

Brightcove player changes may take time

Each time you update and publish a Brightcove player, all plugin files are collected and re-bundled to be distributed with the player files. However, these changes may take a while to propagate across Brightcove's content delivery network (CDN), sometimes up to 24 hours. To test whether a Brightcove player on your site currently has the plugin installed, use the developer console to search the page for the vjs-parsely class. If it's present, the plugin is active and installed on that player. If it's missing, that means the plugin isn't installed, or that the new installation hasn't yet taken effect.

Configuring the Plugin Options

The configuration options for Brightcove plugins are formatted as JSON.

Example Configuration - Standard

For standard integrations, where a Brightcove player is associated with just a single apikey, that's the only option necessary:

  "apikey": ""

Example Configuration - Shared Player

For more complicated setups, where a single player is shared by several different sites and apikeys, you need to provide additional information about how the plugin should determine the apikey (see "Available Options" below for detailed specifications):

  "autodetectApikey": true,
  "apikeyMappings": [
      "domain": "",
      "apikey": ""
      "domain": "",
      "apikey": ""

Available Options

Parameter Type Required Description
apikey string yes, unless autodetectApikey and apikeyMappings specified The "site identifier" used by, which should match the apikey in your standard tracker.
apikeyMappings array no Used in cases where a single Brightcove player is shared across multiple sites with different apikeys. An array of objects that associates each possible domain with its corresponding apikey. For details, see "Formatting apikeyMappings" below.
autodetectApikey boolean no, unless apikey omitted Used in cases where a single Brightcove player is shared across multiple sites with different apikeys. Specifies whether the plugin should attempt to determine the apikey at runtime. By default, it will try to use the hostname of the page the player appears on. For more control, also specify apikeyMappings.
iframeOnly boolean no Whether the plugin should only track videos within <iframe> elements. Defaults to true to avoid interfering with the standard tracker.

Formatting apikeyMappings


Domains will always be checked for matches in the order specified. Specific domain strings should precede more general strings. (For example, if and have separate apikeys, they'd need to be specified in that order, to avoid matching first. See the "Shared Player example] above.)

This optional parameter allows you to provide to associate particular domain patterns with apikeys. The format is a list of objects with these parameters:

Parameter Type Required Description
domain string yes A substring of the hostname that is specific to a given apikey.
apikey string yes The "site identifier" used by, which should match the apikey used in your standard tracking script.
Thanks for your question, we will get back to you shortly!
Do you have an urgent support question?