mirror of
https://github.com/videojs/video.js.git
synced 2025-01-10 23:30:03 +02:00
123 lines
4.1 KiB
Markdown
123 lines
4.1 KiB
Markdown
![Video.js logo][logo]
|
|
|
|
# [Video.js - HTML5 Video Player][vjs]
|
|
|
|
[![Build Status][travis-icon]][travis-link]
|
|
[![Coverage Status][coveralls-icon]][coveralls-link]
|
|
[![Slack Status][slack-icon]][slack-link]
|
|
|
|
[![NPM][npm-icon]][npm-link]
|
|
|
|
> 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][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][builtwith].
|
|
|
|
## Quick Start
|
|
|
|
Thanks to the awesome folks over at [Fastly][fastly], there's a free, CDN hosted version of Video.js that anyone can use. Add these tags to your document's `<head>`:
|
|
|
|
```html
|
|
<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][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][options] - just make sure it contains valid JSON!
|
|
|
|
```html
|
|
<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:
|
|
|
|
```js
|
|
var player = videojs('my-player');
|
|
```
|
|
|
|
The `videojs` function also accepts an `options` object and a callback to be invoked
|
|
when the player is ready:
|
|
|
|
```js
|
|
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][getting-started] page and [documentation][docs] are the best places to go for more information. If you get stuck, head over to our [Slack channel][slack-link]!
|
|
|
|
## 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][contributing] for more!
|
|
|
|
_Video.js uses [BrowserStack][browserstack] for compatibility testing._
|
|
|
|
## [License][license]
|
|
|
|
Video.js is [licensed][license] under the Apache License, Version 2.0.
|
|
|
|
[browserstack]: https://browserstack.com
|
|
|
|
[builtwith]: https://trends.builtwith.com/media/VideoJS
|
|
|
|
[contributing]: CONTRIBUTING.md
|
|
|
|
[coveralls-icon]: https://coveralls.io/repos/github/videojs/video.js/badge.svg?branch=master
|
|
|
|
[coveralls-link]: https://coveralls.io/github/videojs/video.js?branch=master
|
|
|
|
[docs]: http://docs.videojs.com
|
|
|
|
[fastly]: http://www.fastly.com/
|
|
|
|
[getting-started]: http://videojs.com/getting-started/
|
|
|
|
[license]: LICENSE
|
|
|
|
[logo]: http://videojs.com/img/logo.png
|
|
|
|
[npm-icon]: https://nodei.co/npm/video.js.png?downloads=true&downloadRank=true
|
|
|
|
[npm-link]: https://nodei.co/npm/video.js/
|
|
|
|
[options]: docs/guides/options.md
|
|
|
|
[plugins]: http://videojs.com/plugins/
|
|
|
|
[slack-icon]: http://slack.videojs.com/badge.svg
|
|
|
|
[slack-link]: http://slack.videojs.com
|
|
|
|
[travis-icon]: https://travis-ci.org/videojs/video.js.svg?branch=master
|
|
|
|
[travis-link]: https://travis-ci.org/videojs/video.js
|
|
|
|
[vjs]: http://videojs.com
|