1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-04 10:34:51 +02:00
video.js/README.md
2014-11-05 16:01:03 -08:00

2.9 KiB

Video.js logo

Video.js - HTML5 Video Player Build Status

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 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. Simply add these includes to your document's <head>:

<link href="http://vjs.zencdn.net/4.10/video-js.css" rel="stylesheet">
<script src="http://vjs.zencdn.net/4.10/video.js"></script>

Then, whenever you want to use Video.js you can simply use the <video> element as your normally would, but with an additional data-setup attribute containing any Video.js options. These options can include any Video.js option plus potential plugin options, just make sure they're valid JSON!

<video id="really-cool-video" class="video-js vjs-default-skin" controls
 preload="auto" width="640" height="264" poster="really-cool-video-poster.jpg"
 data-setup='{}'>
  <source src="really-cool-video.mp4" type='video/mp4'>
  <source src="really-cool-video.webm" type='video/webm'>
  <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>

If you don't want to use auto-setup, you can leave off the data-setup attribute and initialize a video element manually.

var player = videojs('really-cool-video', { /* Options */ }, function() {
  console.log('Good to go!');

  this.play(); // if you don't trust autoplay for some reason

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

If you're ready to dive in, the documentation is the first place to go for more information. Generally the player API docs are the most pertinent.

Contributing

Video.js is a free and open source library, and we appreciate any help you're willing to give. Check out the contributing guide.

Building your own Video.js from source

To build your own custom version read the section on contributing code and "Building your own copy" in the contributing guide.

License

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

Copyright 2014 Brightcove, Inc.