Video.js - open source HTML5 & Flash video player
Clone or download
Permalink
Failed to load latest commit information.
.github docs: update starter template (#5570) Nov 14, 2018
build chore: Move a11y, lang, browserify, and webpack out of grunt (#5589) Nov 16, 2018
docs docs: update starter template (#5570) Nov 14, 2018
lang feat(lang): Add the Occitan locale (#5578) Nov 14, 2018
sandbox chore: move scss grunt tasks to npm scripts (#5520) Oct 25, 2018
src chore(player): fix linting for a comment (#5588) Nov 14, 2018
test fix(tracks): don't select tracks based on user pref if no langauge is… Nov 6, 2018
.babelrc chore(babel): Upgrade to Babel 7 (#5498) Oct 12, 2018
.editorconfig Added .editorconfig and travis CI badge Dec 11, 2012
.gitignore chore: switch to videojs-generate-karma-config (#5528) Oct 31, 2018
.jsdoc.json chore(https): update a lot of links to be https (#5372) Aug 10, 2018
.npmignore chore(npmignore): don't publish zip file to npm (#5249) Jun 20, 2018
.nvmrc chore: switch to node 8 (#4813) Dec 14, 2017
.remarkignore chore(docs): Documentation Linting and TOC generation (#3841) Dec 20, 2016
.remarkrc.js chore(docs): Documentation Linting and TOC generation (#3841) Dec 20, 2016
.travis.yml chore(travis): remove unused secret variables (#5577) Nov 13, 2018
CHANGELOG.md 7.3.0 Oct 26, 2018
CODE_OF_CONDUCT.md docs(coc): introduce CODE_OF_CONDUCT.md (#4160) Mar 23, 2017
COLLABORATOR_GUIDE.md docs(fixup): fixup docs (#5489) Oct 10, 2018
CONTRIBUTING.md docs: update starter template (#5570) Nov 14, 2018
Gruntfile.js chore(babel): Upgrade to Babel 7 (#5498) Oct 12, 2018
LICENSE More build and testing cleanup. Also some reorganization. Apr 2, 2015
README.md docs: Update urls in README.md to point to v7.3.0 (#5536) Nov 2, 2018
composer.json chore(https): update a lot of links to be https (#5372) Aug 10, 2018
index.html chore: use relative urls in index.html (#5586) Nov 14, 2018
package-lock.json chore: switch from cross-var to cross-env (#5600) Nov 16, 2018
package.json chore: switch from cross-var to cross-env (#5600) Nov 16, 2018
postcss.config.js feat(css): run autoprefixer on css (#5239) Jun 21, 2018
rollup.config.js chore(rollup): fix watch build with globals/externals (#5519) Oct 25, 2018

README.md

Video.js logo

Video.js - HTML5 Video Player

Build Status Coverage Status Greenkeeper badge Slack Status

NPM

Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 and Flash video, as well as YouTube and Vimeo (through plugins). It supports video playback on desktops and mobile devices. This project was started mid 2010, and the player is now used on over 50,000 100,000 200,000 400,000 websites.

Table of Contents

Quick Start

Thanks to the awesome folks over at Fastly, there's a free, CDN hosted version of Video.js that anyone can use. Add these tags to your document's <head>:

<link href="//vjs.zencdn.net/7.3.0/video-js.min.css" rel="stylesheet">
<script src="//vjs.zencdn.net/7.3.0/video.min.js"></script>

For the latest version of video.js and URLs to use, check out the Getting Started page on our website.

Video.js version 7 (and newer) CDN builds do not send any data to Google Analytics.

In older versions of Video.js (6 and earlier), in the vjs.zencdn.net CDN-hosted versions we include a stripped down Google Analytics pixel that tracks a random sampling (currently 1%) of players loaded from the CDN. This allows us to see (roughly) what browsers are in use in the wild, along with other useful metrics such as OS and device. If you'd like to disable analytics, you can simply include the following global before including Video.js via the free CDN:

<script>window.HELP_IMPROVE_VIDEOJS = false;</script>

Alternatively, you can include Video.js by getting it from npm, downloading from GitHub releases or by including it via unpkg or another JavaScript CDN like CDNjs. These releases do not include Google Analytics tracking at all.

<!-- unpkg : use the latest version of Video.js -->
<link href="https://unpkg.com/video.js/dist/video-js.min.css" rel="stylesheet">
<script src="https://unpkg.com/video.js/dist/video.min.js"></script>

<!-- unpkg : use a specific version of Video.js (change the version numbers as necessary) -->
<link href="https://unpkg.com/video.js@6.11.0/dist/video-js.min.css" rel="stylesheet">
<script src="https://unpkg.com/video.js@6.11.0/dist/video.min.js"></script>

<!-- cdnjs : use a specific version of Video.js (change the version numbers as necessary) -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/video.js/6.7.3/video-js.min.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/video.js/6.7.3/video.min.js"></script>

Next, using Video.js is as simple as creating a <video> element, but with an additional data-setup attribute. At a minimum, this attribute must have a value of '{}', but it can include any Video.js options - just make sure it contains valid JSON!

<video
    id="my-player"
    class="video-js"
    controls
    preload="auto"
    poster="//vjs.zencdn.net/v/oceans.png"
    data-setup='{}'>
  <source src="//vjs.zencdn.net/v/oceans.mp4" type="video/mp4"></source>
  <source src="//vjs.zencdn.net/v/oceans.webm" type="video/webm"></source>
  <source src="//vjs.zencdn.net/v/oceans.ogv" type="video/ogg"></source>
  <p class="vjs-no-js">
    To view this video please enable JavaScript, and consider upgrading to a
    web browser that
    <a href="http://videojs.com/html5-video-support/" target="_blank">
      supports HTML5 video
    </a>
  </p>
</video>

When the page loads, Video.js will find this element and automatically setup a player in its place.

If you don't want to use automatic setup, you can leave off the data-setup attribute and initialize a <video> element manually using the videojs function:

var player = videojs('my-player');

The videojs function also accepts an options object and a callback to be invoked when the player is ready:

var options = {};

var player = videojs('my-player', options, function onPlayerReady() {
  videojs.log('Your player is ready!');

  // In this context, `this` is the player that was created by Video.js.
  this.play();

  // How about an event listener?
  this.on('ended', function() {
    videojs.log('Awww...over so soon?!');
  });
});

If you're ready to dive in, the Getting Started page and documentation are the best places to go for more information. If you get stuck, head over to our Slack channel!

Contributing

Video.js is a free and open source library, and we appreciate any help you're willing to give - whether it's fixing bugs, improving documentation, or suggesting new features. Check out the contributing guide for more!

Video.js uses BrowserStack for compatibility testing.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Video.js is licensed under the Apache License, Version 2.0.