Brightcove Player Loader



An asynchronous script loader for the Brightcove Player.

Table of Contents generated with DocToc

- License
- Why do I need this library?
- Brightcove Player Support
- Browser Support
- Installation
- Inclusion
- ES6 Modules (e.g. Rollup, Webpack)
- CommonJS (e.g. Browserify)
- AMD (e.g. RequireJS)
-

`

Usage


> Note: If you want to use this with React, we have an official react component called @brightcove/react-player-loader

The Brightcove Player Loader exposes a single function. This function takes an parameters object which describes the player it should load and returns a Promise which resolves when the player is loaded and created and rejects if anything fails.

$3

This is a minimal example, using only the required parameters, which will load a Video Cloud account's default player:

`js
brightcovePlayerLoader({
refNode: someElement,
accountId: '123456789'
});
`

This is a more complete example, using some optional parameters and handling the returned Promise:

`js
brightcovePlayerLoader({
refNode: someElement,
refNodeInsert: 'replace',
accountId: '123456789',
playerId: 'AbCDeFgHi',
embedId: 'default',
videoId: '987654321'
})
.then(function(success) {
// The player has been created!
})
.catch(function(error) {
// Player creation failed!
});
`

$3

This library will attempt to detect pre-existing players on the page. In other words, if this library runs after a Brightcove Player script was included earlier in the DOM, it will detect it and prevent additional downloads of the same player. For example:

`






`

However, there is a limitation to this behavior. Players from separate accounts on the same page are not guaranteed to be properly detected. _This is considered an unsupported use-case._

$3

When used with [the related webpack plugin][webpack-plugin], you can take advantage of the Player Loader's embed creation capabilities while avoiding an additional, asynchronous request by bundling your Brightcove Player into your webpack bundle.

Simply configure both libraries simultaneously and your player(s) should be bundled and no longer download asynchronously.

$3

By default, this library will look for a global Promise. However, you can explicitly provide a Promise implementation via the Promise parameter:

`js
brightcovePlayerLoader({
refNode: someElement,
accountId: '123456789',
playerId: 'AbCDeFgHi',
Promise: MyCustomPromise
})
.then(function(success) {
// The player has been created!
})
.catch(function(error) {
// Player creation failed!
});
`

Promises are not required for this library to work, but they are recommended. The only major browser that does not support Promise natively is IE11. We recommend polyfilling the window.Promise constructor if it does not exist.

In cases where no Promise global exists and none is provided, the Brightcove Player Loader will return undefined. There are callbacks available, which can be used instead of Promise - passing them will prevent a Promise from being returned:

`js
brightcovePlayerLoader({
refNode: someElement,
accountId: '123456789',
onSuccess: function(success) {
// The player has been created!
},
onFailure: function(error) {
// Player creation failed!
}
});
`

> NOTE: Providing these callbacks means opting-out of promises entirely. No Promise object will be returned!

#### Success
For resolved Promises or onSuccess callbacks, a single argument will be passed. This "success object" can have the following properties:

Property | Description
---------|------------
type | Either 'in-page' or 'iframe', describing the type of embed that was created.
ref | The type of value assigned to this property will vary by the type. For 'in-page' embeds, it will be a [Video.js Player object][vjs-player] and for 'iframe' embeds, it will be the