1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-14 11:23:30 +02:00
Video.js - open source HTML5 video player
Go to file
2016-12-21 14:23:00 -05:00
.github chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00
build test: add Edge to browserstack tests (#3834) 2016-12-05 16:22:09 -05:00
docs chore(faq): move FAQ and troubleshooting guide to docs/ (#3883) 2016-12-20 18:21:18 -05:00
lang feat(lang): update uk.json (#3675) 2016-11-03 16:07:49 -04:00
sandbox docs(guides): Manual Documentation Improvements (#3703) 2016-12-02 14:27:59 -05:00
src feat: deprecate the use of starttime in player.js (#3838) 2016-12-21 14:23:00 -05:00
test feat(player): ingest a player div for videojs (#3856) 2016-12-19 11:51:42 -05:00
.babelrc chore(package): remove es2015-loose since it's an option for es2015 (#3629) 2016-09-29 13:44:55 -04:00
.editorconfig Added .editorconfig and travis CI badge 2012-12-11 14:33:42 -08:00
.gitignore @gkatsev updated build system to open es5 folder for bundles and dist folder other users. closes #3445 2016-08-17 17:16:41 -04:00
.jsdoc.json docs(jsdoc): Update the jsdoc comments to modern syntax - Part 1 (#3694) 2016-12-02 15:07:19 -05:00
.npmignore @gkatsev updated build system to open es5 folder for bundles and dist folder other users. closes #3445 2016-08-17 17:16:41 -04:00
.remarkignore chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00
.remarkrc.js chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00
.travis.yml @misteroneill enabled and updated videojs-standard and fixed an issue with linting. closes #3508 2016-08-11 18:33:34 -04:00
bower.json @DatTran fixed bower paths. Fixes #2740. closes #2775 2015-11-20 17:22:49 -05:00
CHANGELOG.md v5.14.1 2016-12-05 17:04:35 -05:00
COLLABORATOR_GUIDE.md chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00
component.json v5.14.1 2016-12-05 17:04:35 -05:00
composer.json Added a composer.json for PHP packages. closes #1241 2014-06-13 17:01:11 -07:00
contrib.json chore: update CHANGELOG automation to use conventional-changelog (#3669) 2016-10-06 14:09:48 -04:00
CONTRIBUTING.md chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00
Gruntfile.js @gkatsev updated build system to open es5 folder for bundles and dist folder other users. closes #3445 2016-08-17 17:16:41 -04:00
LICENSE More build and testing cleanup. Also some reorganization. 2015-04-02 11:33:51 -07:00
package.json chore(videojs-standard): update to version 6.0.1 (#3884) 2016-12-20 18:32:24 -05:00
README.md chore(docs): Documentation Linting and TOC generation (#3841) 2016-12-20 16:55:59 -05:00

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.

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.11/video-js.min.css" rel="stylesheet">
<script src="//vjs.zencdn.net/5.11/video.min.js"></script>

For the latest URLs, check out the Getting Started page on our website.

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.

License

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