JavaScript
A simple HTML5, YouTube and Vimeo player

Plyr

A simple, accessible and customizable HTML5, YouTube and Vimeo media player.

Checkout the demo

Why?

We wanted a lightweight, accessible and customizable media player that supports modern browsers. Sure, there are many other players out there but we wanted to keep things simple, using the right elements for the job.

Features

• Accessible - full support for VTT captions and screen readers
• Lightweight - under 10KB minified and gzipped
• Customisable - make the player look how you want with the markup you want
• Semantic - uses the right elements. <input type="range"> for volume and <progress> for progress and well, <button>s for buttons. There's no <span> or <a href="#"> button hacks
• Responsive - as you'd expect these days
• HTML Video & Audio - support for both formats
• Embedded Video - support for YouTube and Vimeo video playback
• API - toggle playback, volume, seeking, and more
• Universal events - no messing around with Vimeo and YouTube APIs, all events are universal across formats
• Fullscreen - supports native fullscreen with fallback to "full window" modes
• i18n support - support for internationalization of controls
• No dependencies - written in "vanilla" JavaScript, no jQuery required

Oh and yes, it works with Bootstrap.

Changelog

Check out the changelog to see what's new with Plyr.

Planned Development

• Streaming
• Playback speed
• Playlists
• Multiple language captions (with selection)
• Audio captions ... and whatever else has been raised in issues

If you have any cool ideas or features, please let me know by creating an issue or, of course, forking and sending a pull request.

Implementation

Check docs/index.html and docs/dist/docs.js for an example setup.

Heads up: the example index.html file needs to be served from a webserver (such as Apache, Nginx, IIS or similar) unless you change the file sources to include http or https. e.g. change //cdn.plyr.io/1.6.11/plyr.js to https://cdn.plyr.io/1.6.11/plyr.js

Node Package Manager (NPM)

Using NPM, you can grab Plyr:

npm install plyr

https://www.npmjs.com/package/plyr

Bower

If bower is your thang, you can grab Plyr using:

bower install plyr

http://bower.io/search/?q=plyr

More info on setting up dependencies can be found in the Bower Docs

Ember

The awesome @louisrudner has created an ember component, available by running:

ember addon:install ember-cli-plyr

More info is on npm and GitHub

CDN

If you want to use our CDN, you can use the following:

<link rel="stylesheet" href="https://cdn.plyr.io/1.6.11/plyr.css">
<script src="https://cdn.plyr.io/1.6.11/plyr.js"></script>

The SVG sprite/defs file can be found here: https://cdn.plyr.io/1.6.11/plyr.svg.

CSS & Styling

If you want to use the default css, add the plyr.css file from /dist into your head, or even better use plyr.less or plyr.scss file included in /src in your build to save a request.

<link rel="stylesheet" href="dist/plyr.css">

The default setup uses the BEM methodology with plyr as the block, e.g. .plyr__controls. You can change the class hooks in the options. Check out the source for more on this.

SVG

The SVG sprite for the controls icons can be loaded two ways:

• By passing the relative path to the sprite as the iconUrl option; or
• Using AJAX, injecting the sprite into a hidden div.

Using the iconUrl option

This method requires the SVG sprite to be hosted on the same domain as your page hosting the player. Currently no browser supports cross origin SVG sprites due to XSS issues. Fingers crossed this will come soon though. An example value for this option would be:

/path/to/plyr.svg

Using AJAX

Using AJAX means you can load the sprite from a different origin. Avoiding the issues above. This is an example script to load an SVG sprite best added before the closing </body>, before any other scripts.

<script>
(function(d, p){
    var a = new XMLHttpRequest(),
        b = d.body;
    a.open('GET', p, true);
    a.send();
    a.onload = function() {
        var c = d.createElement('div');
        c.setAttribute('hidden', '');
        c.innerHTML = a.responseText;
        b.insertBefore(c, b.childNodes[0]);
    };
})(document, 'https://cdn.plyr.io/1.6.11/plyr.svg');
</script>

If you're using the <base> 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/

HTML

The only extra markup that's needed to use plyr is a <div> wrapper. Replace the source, poster and captions with urls for your media.

<div class="plyr">
    <video poster="/path/to/poster.jpg" controls>
        <!-- Video files -->
        <source src="/path/to/video.mp4" type="video/mp4">
        <source src="/path/to/video.webm" type="video/webm">

        <!-- Text track file -->
        <track kind="captions" label="English captions" src="/path/to/captions.vtt" srclang="en" default>

        <!-- Fallback for browsers that don't support the <video> element -->
        <a href="/path/to/movie.mp4">Download</a>
    </video>
</div>

And the same for <audio>

<div class="plyr">
    <audio controls>
        <!-- Audio files -->
        <source src="/path/to/audio.mp3" type="audio/mp3">
        <source src="/path/to/audio.ogg" type="audio/ogg">

        <!-- Fallback for browsers that don't support the <audio> element -->
        <a href="/path/to/audio.mp3">Download</a>
    </audio>
</div>

For YouTube and Vimeo, Plyr uses the standard YouTube API markup (an empty <div>):

<div class="plyr">
    <div data-video-id="bTqVqk7FSmY" data-type="youtube"></div>
</div>

<div class="plyr">
    <div data-video-id="143418951" data-type="vimeo"></div>
</div>

Cross Origin (CORS)

You'll notice the crossorigin attribute on the example <video> and <audio> elements. This is because the media is loaded from another domain. If your media is hosted on another domain, you may need to add this attribute.

More info on CORS here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS

Captions

WebVTT captions are supported. To add a caption track, check the HTML example above and look for the <track> element.

Be sure to validate your caption files

JavaScript

Quick setup

Here's an example of a default setup:

<script src="https://cdn.plyr.io/1.6.11/plyr.js"></script>
<script>plyr.setup();</script>

This will look for all elements with the specified container classname (default is plyr) and setup plyr on each element found. You can specify other options, including a different selector hook below. The container classname will be added to the specified element(s) if it is not already present (for the CSS).

You can initialize the player a few other ways:

Passing a NodeList:

plyr.setup(document.querySelectorAll('.js-plyr'), options);

Passing a HTMLElement:

plyr.setup(document.querySelector('.js-plyr'), options);

Passing a string selector:

plyr.setup('.js-plyr', options);

Passing just the options object:

plyr.setup(options);

RangeTouch

Some touch browsers (particularly Mobile Safari on iOS) seem to have issues with <input type="range"> 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.

Options

Options must be passed as an object to the setup() method as above or as JSON in data-plyr attribute on each of your target elements (e.g. data-plyr='{ title: "testing" }') - note the single quotes encapsulating the JSON.

Fullscreen options

API

Fetching the plyr instance

A plyr object is added to any element that Plyr is initialized on. You can then control the player by accessing methods in the plyr object.

There are two ways to access the instance, firstly you re-query the element container you used for setup (e.g. .js-plyr) like so:

var player = document.querySelector('.js-plyr').plyr;

Or you can use the returned object from your call to the setup method:

var player = plyr.setup('.js-plyr')[0];

This will return an array of plyr instances setup, so you need to specify the index of the instance you want. This is less useful if you are setting up mutliple instances. You can listen for the setup event documented below which will return each instance one by one, as they are setup (in the plyr key of the event object).

Once you have your instance, you can use the API methods below on it. For example to pause it:

player.pause();

Here's a list of the methods supported:

.source() method

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

Video example:

player.source({
  type:       'video',
  title:      'Example title',
  sources: [{
      src:    '/path/to/movie.mp4',
      type:   'video/mp4'
  },
  {
      src:    '/path/to/movie.webm',
      type:   'video/webm'
  }],
  poster:     '/path/to/poster.jpg',
  tracks:     [{
      kind:   'captions',
      label:  'English',
      srclang:'en',
      src:    '/path/to/captions.vtt',
      default: true
  }]
});

Audio example:

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

YouTube example:

player.source({
  type:       'video',
  title:      'Example title',
  sources: [{
      src:    'bTqVqk7FSmY',
      type:   'youtube'
  }]
});

Vimeo example

player.source({
  type:       'video',
  title:      'Example title',
  sources: [{
      src:    '143418951',
      type:   'vimeo'
  }]
});

Some more details on the object parameters

Events

You can listen for events on the element you setup Plyr on. Some events only apply to HTML5 audio and video.

Details borrowed from: https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events

Here's an example of binding an event listener:

document.querySelector('.js-plyr').addEventListener('ready', function() {
    var player = event.target.plyr;
});

Embeds

YouTube and Vimeo are currently supported and function much like a HTML5 video. Check the relevant documentation sections for any differences.

Plyr references a custom version of the Vimeo Froogaloop API as Vimeo have neglected to maintain the library and there were bugs with their version. You don't need to worry about including your own versions of the Vimeo or YouTube JavaScript APIs.

The native API's can be accessed through the embed property of the plyr object. For example:

document.querySelector('.js-plyr').addEventListener('ready', function() {
    var player = event.target.plyr;

    // YouTube
    console.log(player.embed.getVideoData());

    // Vimeo
    console.log(player.embed.api('getColor'));
});

More info on the respective API's here: YouTube API Reference Vimeo API Reference

Please note: not all API methods may work 100%. Your mileage may vary. It's better to use the universal plyr API where possible.

Fullscreen

Fullscreen in Plyr is supported for all browsers that currently support it. If you're using the default CSS, you can also use a "full browser" mode which will use the full browser window by adding the plyr-fullscreen class to your container.

Browser support

¹ Mobile Safari on the iPhone forces the native player for <video> so no useful customisation is possible. <audio> elements have volume controls disabled.

² Native player used (no support for <progress> or <input type="range">) but the API is supported (v1.0.28+)

³ IE10 has no native fullscreen support, fallback can be used (see options)

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

enabled: /Android|webOS|iPhone|iPad|iPod|BlackBerry/i.test(navigator.userAgent)

If a User Agent is disabled but supports <video> and <audio> natively, it will use the native player.

Any unsupported browsers will display links to download the media if the correct html is used.

Checking for support

There's an API method for checking support. You can call plyr.supported() and optionally pass a type to it, e.g. plyr.supported("video"). It will return an object with two keys; basic meaning there's basic support for that media type (or both if no type is passed) and full meaning there's full support for plyr.

Issues

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

Author

Plyr is developed by @sam_potts / sampotts.me with help from the awesome contributors

Mentions

• ProductHunt
• The Changelog
• HTML5 Weekly #177
• Responsive Design #149
• Web Design Weekly #174
• Hacker News
• Web Platform Daily
• LayerVault Designer News
• The Treehouse Show #131
• noupe.com

Used by

• Selz.com
• koel - A personal music streaming server that works.
• Oscar Radio

Let me know on Twitter I can add you to the above list. It'd be awesome to see how you're using Plyr :-)

Useful links and credits

Credit to the PayPal HTML5 Video player from which Plyr's caption functionality is ported from:

• PayPal's Accessible HTML5 Video Player
• The icons used in Plyr are Vicons plus some ones I made
• An awesome guide for Plyr in Japanese! by @arayutw

Also these links helped created Plyr:

• Media Events - W3.org
• Styling the <progress> element - hongkiat.com

Copyright and License

The MIT license.