JavaScript CSS Other
Switch branches/tags
Latest commit 4d88b61 Dec 15, 2017 @gkatsev gkatsev 6.6.0
Permalink
Failed to load latest commit information.
.github chore(docs): Documentation Linting and TOC generation (#3841) Dec 20, 2016
build chore: remove unused deps (#4814) Dec 14, 2017
docs feat: add support for debug logging (#4780) Dec 14, 2017
lang chore(lang): Add translation for "caption settings" in zh-CN.json (#4815 Dec 14, 2017
sandbox feat: allow embeds via <video-js> element (#4640) Nov 13, 2017
src feat(css): add a delay before showing loading spinner (#4806) Dec 14, 2017
test fix: modify debug log tests to accomodate old IE stringification (#4824) Dec 14, 2017
.babelrc feat: Use Rollup to generate dist files (#4301) May 25, 2017
.editorconfig Added .editorconfig and travis CI badge Dec 11, 2012
.gitignore chore: gitignore all npm-debug.log.* (#4252) Apr 7, 2017
.jsdoc.json docs: make jsdoc generate anchor names so ToC links work (#4471) Jul 14, 2017
.npmignore docs: deploy docs using netlify (#4774) Dec 4, 2017
.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: switch to node 8 (#4813) Dec 14, 2017
CHANGELOG.md 6.6.0 Dec 15, 2017
CODE_OF_CONDUCT.md docs(coc): introduce CODE_OF_CONDUCT.md (#4160) Mar 23, 2017
COLLABORATOR_GUIDE.md docs(COLLABORATOR_GUIDE): how to release Video.js (#4586) Aug 30, 2017
CONTRIBUTING.md docs: Expand testing info in `CONTRIBUTING.md` (#4020) Feb 2, 2017
Gruntfile.js @gkatsev updated build system to open es5 folder for bundles and dist… Aug 17, 2016
LICENSE More build and testing cleanup. Also some reorganization. Apr 2, 2015
README.md docs(readme): fixed a typo (#4730) Nov 8, 2017
composer.json Added a composer.json for PHP packages. closes #1241 Jun 14, 2014
package-lock.json chore: remove unused deps (#4814) Dec 14, 2017
package.json 6.6.0 Dec 15, 2017

README.md

Video.js logo

Video.js - HTML5 Video Player

Build Status Coverage Status 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/5.19/video-js.min.css" rel="stylesheet">
<script src="//vjs.zencdn.net/5.19/video.min.js"></script>

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

In the vjs.zencdn.net CDN-hosted versions of Video.js 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 -->
<link href="https://unpkg.com/video.js/dist/video-js.css" rel="stylesheet">
<script src="https://unpkg.com/video.js/dist/video.js"></script>

<!-- cdnjs -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/video.js/6.3.3/video-js.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/video.js/6.3.3/video.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.