wplayer

Features

- Accessible - full support for VTT captions and screen readers
- Customisable - make the player look how you want with the markup you want
- Good HTML - uses the _right_ elements. for volume and for progress and well, s for buttons. There's no
or button hacks
- Responsive - works with any screen size
- HTML Video & Audio - support for both formats
- Monetization - make money from your videos
- Streaming - support for hls.js, Shaka and dash.js streaming playback
- API - toggle playback, volume, seeking, and more through a standardized API
- Events - no messing around with Vimeo and YouTube APIs, all events are standardized across formats
- Fullscreen - supports native fullscreen with fallback to "full window" modes
- Shortcuts - supports keyboard shortcuts
- Picture-in-Picture - supports Safari's picture-in-picture mode
- Playsinline - supports the playsinline attribute
- Speed controls - adjust speed on the fly
- Multiple captions - support for multiple caption tracks
- i18n support - support for internationalization of controls
- No dependencies - written in "vanilla" ES6 JavaScript, no jQuery required
- SASS - to include in your build processes

$3

Player extends upon the standard HTML5 media element markup so that's all you need for those types.

#### HTML5 Video

``html





`

#### HTML5 Audio

`html

`




$3

The icons used in the Player controls are loaded in an SVG sprite. The sprite is automatically loaded from our CDN by default. If you already have an icon build
system in place, you can include the source plyr icons (see /src/sprite for source icons).

#### Using the iconUrl option

You can however specify your own iconUrl option and Player will determine if the url is absolute and requires loading by AJAX/CORS due to current browser
limitations or if it's a relative path, just use the path directly.

If you're using the tag on your site, you may need to use something like this: svgfixer.js

More info on SVG sprites here: http://css-tricks.com/svg-sprites-use-better-icon-fonts/ and the AJAX
technique here: http://css-tricks.com/ajaxing-svg-sprite/


#### Using the inlineSvg option

You can specify inlineSvg option like this:

`
const inlineSvg = require('wplayer/dist/plyr.svg');

const player = new Player(someSelector, {
controls: [
...
],
loadSprite: true,
inlineSvg
});

`

$3

You'll notice the crossorigin attribute on the example

$3

WebVTT captions are supported. To add a caption track, check the HTML example above and look for the element. Be sure to
validate your caption files.

$3

#### Initialising

You can specify a range of arguments for the constructor to use:

- A CSS string selector that's compatible with querySelector
- A HTMLElement
- A NodeList
- A jQuery object

_Note_: If a NodeList, Array, or jQuery object are passed, the first element will be used for setup. To setup multiple players, see setting up multiple players below.

Here's some examples

Passing a string selector:

`javascript
const player = new Player('#player');
`

Passing a HTMLElement:

`javascript
const player = new Player(document.getElementById('player'));
`

Passing a NodeList (see note below):

`javascript
const player = new Player(document.querySelectorAll('.js-player'));
`

The NodeList, HTMLElement or string selector can be the target

wrapper for embeds.

##### Setting up multiple players

You have two choices here. You can either use a simple array loop to map the constructor:

`javascript
const players = Array.from(document.querySelectorAll('.js-player')).map(p => new Player(p));
`

...or use a static method where you can pass a string selector, a NodeList or an Array of elements:

`javascript
const players = Player.setup('.js-player');
`

Both options will also return an array of instances in the order of they were in the DOM for the string selector or the source NodeList or Array.

##### Passing options

The second argument for the constructor is the options object:

`javascript
const player = new Player('#player', {
/ options /
});
`

In all cases, the constructor will return a Player object that can be used with the API methods. See the API section for more info.

#### Options

Options can be passed as an object to the constructor as above or as JSON in data-plyr-config attribute on each of your target elements:

`html

`

Note the single quotes encapsulating the JSON and double quotes on the object keys. Only string values need double quotes.

| Option | Type | Default | Description |
| -------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | Boolean | true | Completely disable Player. This would allow you to do a User Agent check or similar to programmatically enable or disable Player for a certain UA. Example below. |
| debug | Boolean | false | Display debugging information in the console |
| controls | Array, Function or Element | ['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen'] | If a function is passed, it is assumed your method will return either an element or HTML string for the controls. Three arguments will be passed to your function; id (the unique id for the player), seektime (the seektime step in seconds), and title (the media title). See controls.md for more info on how the html needs to be structured. |
| settings | Array | ['captions', 'quality', 'speed', 'loop'] | If you're using the default controls are used then you can specify which settings to show in the menu |
| i18n | Object | See defaults.js | Used for internationalization (i18n) of the text within the UI. |
| loadSprite | Boolean | true | Load the SVG sprite specified as the iconUrl option (if a URL). If false, it is assumed you are handling sprite loading yourself. |
| iconUrl | String | null | Specify a URL or path to the SVG sprite. See the SVG section for more info. |
| iconPrefix | String | plyr | Specify the id prefix for the icons used in the default controls (e.g. "plyr-play" would be "plyr"). This is to prevent clashes if you're using your own SVG sprite but with the default controls. Most people can ignore this option. |
| blankVideo | String | https://cdn.plyr.io/static/blank.mp4 | Specify a URL or path to a blank video file used to properly cancel network requests. |
| autoplay | Boolean | false | Autoplay the media on load. This is generally advised against on UX grounds. It is also disabled by default in some browsers. If the autoplay attribute is present on a

1. Vimeo only

API

There are methods, setters and getters on a Player object.

$3

The easiest way to access the Player object is to set the return value from your call to the constructor to a variable. For example:

`javascript
const player = new Player('#player', {
/ options /
});
`

You can also access the object through any events:

`javascript
element.addEventListener('ready', event => {
const player = event.detail.plyr;
});
`

$3

Example method use:

`javascript
player.play(); // Start playback
player.fullscreen.enter(); // Enter fullscreen
`

| Method | Parameters | Description |
| ------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
| play()¹ | - | Start playback. |
| pause() | - | Pause playback. |
| togglePlay(toggle) | Boolean | Toggle playback, if no parameters are passed, it will toggle based on current status. |
| stop() | - | Stop playback and reset to start. |
| restart() | - | Restart playback. |
| rewind(seekTime) | Number | Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used. |
| forward(seekTime) | Number | Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used. |
| increaseVolume(step) | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
| decreaseVolume(step) | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
| toggleCaptions(toggle) | Boolean | Toggle captions display. If no parameter is passed, it will toggle based on current status. |
| fullscreen.enter() | - | Enter fullscreen. If fullscreen is not supported, a fallback "full window/viewport" is used instead. |
| fullscreen.exit() | - | Exit fullscreen. |
| fullscreen.toggle() | - | Toggle fullscreen. |
| airplay() | - | Trigger the airplay dialog on supported devices. |
| toggleControls(toggle) | Boolean | Toggle the controls (video only). Takes optional truthy value to force it on/off. |
| on(event, function) | String, Function | Add an event listener for the specified event. |
| once(event, function) | String, Function | Add an event listener for the specified event once. |
| off(event, function) | String, Function | Remove an event listener for the specified event. |
| supports(type) | String | Check support for a mime type. |
| destroy() | - | Destroy the instance and garbage collect any elements. |

1. For HTML5 players, play() will return a Promise in _some_ browsers - WebKit and Mozilla according to MDN at time of writing.

$3

Example setters:

`javascript
player.volume = 0.5; // Sets volume at 50%
player.currentTime = 10; // Seeks to 10 seconds
`

Example getters:

`javascript
player.volume; // 0.5;
player.currentTime; // 10
player.fullscreen.active; // false;
`

| Property | Getter | Setter | Description |
| -------------------- | ------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| isHTML5 | ✓ | - | Returns a boolean indicating if the current player is HTML5. |
| isEmbed | ✓ | - | Returns a boolean indicating if the current player is an embedded player. |
| playing | ✓ | - | Returns a boolean indicating if the current player is playing. |
| paused | ✓ | - | Returns a boolean indicating if the current player is paused. |
| stopped | ✓ | - | Returns a boolean indicating if the current player is stopped. |
| ended | ✓ | - | Returns a boolean indicating if the current player has finished playback. |
| buffered | ✓ | - | Returns a float between 0 and 1 indicating how much of the media is buffered |
| currentTime | ✓ | ✓ | Gets or sets the currentTime for the player. The setter accepts a float in seconds. |
| seeking | ✓ | - | Returns a boolean indicating if the current player is seeking. |
| duration | ✓ | - | Returns the duration for the current media. |
| volume | ✓ | ✓ | Gets or sets the volume for the player. The setter accepts a float between 0 and 1. |
| muted | ✓ | ✓ | Gets or sets the muted state of the player. The setter accepts a boolean. |
| hasAudio | ✓ | - | Returns a boolean indicating if the current media has an audio track. |
| speed | ✓ | ✓ | Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5. |
| quality¹ | ✓ | ✓ | Gets or sets the quality for the player. The setter accepts a value from the options specified in your config. |
| loop | ✓ | ✓ | Gets or sets the current loop state of the player. The setter accepts a boolean. |
| source | ✓ | ✓ | Gets or sets the current source for the player. The setter accepts an object. See source setter below for examples. |
| poster | ✓ | ✓ | Gets or sets the current poster image for the player. The setter accepts a string; the URL for the updated poster image. |
| autoplay | ✓ | ✓ | Gets or sets the autoplay state of the player. The setter accepts a boolean. |
| currentTrack | ✓ | ✓ | Gets or sets the caption track by index. -1 means the track is missing or captions is not active |
| language | ✓ | ✓ | Gets or sets the preferred captions language for the player. The setter accepts an ISO two-letter language code. Support for the languages is dependent on the captions you include. If your captions don't have any language data, or if you have multiple tracks with the same language, you may want to use currentTrack instead. |
| fullscreen.active | ✓ | - | Returns a boolean indicating if the current player is in fullscreen mode. |
| fullscreen.enabled | ✓ | - | Returns a boolean indicating if the current player has fullscreen enabled. |
| pip² | ✓ | ✓ | Gets or sets the picture-in-picture state of the player. The setter accepts a boolean. This currently only supported on Safari 10+ (on MacOS Sierra+ and iOS 10+) and Chrome 70+. |

1. YouTube only. HTML5 will follow.
2. HTML5 only

#### The .source setter

This allows changing the player source and type on the fly.

Video example:

`javascript
player.source = {
type: 'video',
title: 'Example title',
sources: [
{
src: '/path/to/movie.mp4',
type: 'video/mp4',
size: 720,
},
{
src: '/path/to/movie.webm',
type: 'video/webm',
size: 1080,
},
],
poster: '/path/to/poster.jpg',
tracks: [
{
kind: 'captions',
label: 'English',
srclang: 'en',
src: '/path/to/captions.en.vtt',
default: true,
},
{
kind: 'captions',
label: 'French',
srclang: 'fr',
src: '/path/to/captions.fr.vtt',
},
],
};
`

Audio example:

`javascript
player.source = {
type: 'audio',
title: 'Example title',
sources: [
{
src: '/path/to/audio.mp3',
type: 'audio/mp3',
},
{
src: '/path/to/audio.ogg',
type: 'audio/ogg',
},
],
};
`


_Note:_ src property for YouTube and Vimeo can either be the video ID or the whole URL.

| Property | Type | Description |
| -------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | String | Either video or audio. _Note:_ YouTube and Vimeo are currently not supported as audio sources. |
| title | String | _Optional._ Title of the new media. Used for the aria-label attribute on the play button, and outer container. YouTube and Vimeo are populated automatically. |
| sources | Array | This is an array of sources. For HTML5 media, the properties of this object are mapped directly to HTML attributes so more can be added to the object if required. |
| poster¹ | String | The URL for the poster image (HTML5 video only). |
| tracks¹ | String | An array of track objects. Each element in the array is mapped directly to a track element and any keys mapped directly to HTML attributes so as in the example above, it will render as and similar for the French version. Booleans are converted to HTML5 value-less attributes. |

1. HTML5 only

Events

You can listen for events on the target element you setup Player on (see example under the table). Some events only apply to HTML5 audio and video. Using your
reference to the instance, you can use the on() API method or addEventListener(). Access to the API can be obtained this way through the event.detail.plyr
property. Here's an example:

`javascript
player.on('ready', event => {
const instance = event.detail.plyr;
});
`

$3

| Event Type | Description |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| progress | Sent periodically to inform interested parties of progress downloading the media. Information about the current amount of the media that has been downloaded is available in the media element's buffered attribute. |
| playing | Sent when the media begins to play (either for the first time, after having been paused, or after ending and then restarting). |
| play | Sent when playback of the media starts after having been paused; that is, when playback is resumed after a prior pause event. |
| pause | Sent when playback is paused. |
| timeupdate | The time indicated by the element's currentTime attribute has changed. |
| volumechange | Sent when the audio volume changes (both when the volume is set and when the muted state is changed). |
| seeking | Sent when a seek operation begins. |
| seeked | Sent when a seek operation completes. |
| ratechange | Sent when the playback speed changes. |
| ended | Sent when playback completes. _Note:_ This does not fire if autoplay is true. |
| enterfullscreen | Sent when the player enters fullscreen mode (either the proper fullscreen or full-window fallback for older browsers). |
| exitfullscreen | Sent when the player exits fullscreen mode. |
| captionsenabled | Sent when captions are enabled. |
| captionsdisabled | Sent when captions are disabled. |
| languagechange | Sent when the caption language is changed. |
| controlshidden | Sent when the controls are hidden. |
| controlsshown | Sent when the controls are shown. |
| ready | Triggered when the instance is ready for API calls. |

#### HTML5 only

| Event Type | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| loadstart | Sent when loading of the media begins. |
| loadeddata | The first frame of the media has finished loading. |
| loadedmetadata | The media's metadata has finished loading; all attributes now contain as much useful information as they're going to. |
| qualitychange | The quality of playback has changed. |
| canplay | Sent when enough data is available that the media can be played, at least for a couple of frames. This corresponds to the HAVE_ENOUGH_DATA readyState. |
| canplaythrough | Sent when the ready state changes to CAN_PLAY_THROUGH, indicating that the entire media can be played without interruption, assuming the download rate remains at least at the current level. _Note:_ Manually setting the currentTime will eventually fire a canplaythrough event in firefox. Other browsers might not fire this event. |
| stalled | Sent when the user agent is trying to fetch media data, but data is unexpectedly not forthcoming. |
| waiting | Sent when the requested operation (such as playback) is delayed pending the completion of another operation (such as a seek). |
| emptied | he media has become empty; for example, this event is sent if the media has already been loaded (or partially loaded), and the load() method is called to reload it. |
| cuechange | Sent when a TextTrack has changed the currently displaying cues. |
| error | Sent when an error occurs. The element's error attribute contains more information. |




Shortcuts

By default, a player will bind the following keyboard shortcuts when it has focus. If you have the global option to true and there's only one player in the
document then the shortcuts will work when any element has focus, apart from an element that requires input.

| Key | Action |
| ---------- | -------------------------------------- |
| 0 to 9 | Seek from 0 to 90% respectively |
| space | Toggle playback |
| K | Toggle playback |
| ← | Seek backward by the seekTime option |
| → | Seek forward by the seekTime option |
| ↑ | Increase volume |
| ↓ | Decrease volume |
| M | Toggle mute |
| F | Toggle fullscreen |
| C | Toggle captions |
| L | Toggle loop |

Fullscreen

Fullscreen in Player is supported by all browsers that currently support it.

Browser support

Player supports the last 2 versions of most _modern_ browsers.

| Browser | Supported |
| ------------- | ------------- |
| Safari | ✓ |
| Mobile Safari | ✓¹ |
| Firefox | ✓ |
| Chrome | ✓ |
| Opera | ✓ |
| Edge | ✓ |
| IE11 | ✓³ |
| IE10 | ✓²³ |

1. Mobile Safari on the iPhone forces the native player for

$3

Player uses ES6 which isn't supported in all browsers quite yet. This means some features will need to be polyfilled to be available otherwise you'll run into issues. We've elected to not burden the ~90% of users that do support these features with extra JS and instead leave polyfilling to you to work out based on your needs. The easiest method I've found is to use polyfill.io which provides polyfills based on user agent. This is the method the demo uses.

$3

You can use the static method to check for support. For example

`javascript
const supported = Player.supported('video', 'html5', true);
`

The arguments are:

- Media type (audio or video)
- Provider (html5, youtube or vimeo)
- Whether the player has the playsinline attribute (only applicable to iOS 10+)

$3

The enabled option can be used to disable certain User Agents. For example, if you don't want to use Player for smartphones, you could use:

`javascript
{
enabled: /Android|webOS|iPhone|iPad|iPod|BlackBerry/i.test(navigator.userAgent);
}
`

If a User Agent is disabled but supports

RangeTouch

Some touch browsers (particularly Mobile Safari on iOS) seem to have issues with ` elements whereby touching the track to set the value
doesn't work and sliding the thumb can be tricky. To combat this, I've created RangeTouch which I'd recommend including in your
solution. It's a tiny script with a nice benefit for users on touch devices.

Issues

If you find anything weird with Player, please let us know using the GitHub issues tracker.

Copyright and License

The MIT license

Show more