mirror of
https://github.com/videojs/video.js.git
synced 2024-12-23 02:04:34 +02:00
161 lines
6.4 KiB
Markdown
161 lines
6.4 KiB
Markdown
![Video.js logo][logo]
|
|
|
|
# [Video.js - HTML5 Video Player][vjs]
|
|
|
|
[![Build Status][travis-icon]][travis-link]
|
|
[![Coverage Status][coveralls-icon]][coveralls-link]
|
|
[](https://greenkeeper.io/)
|
|
[![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].
|
|
|
|
## Table of Contents
|
|
|
|
* [Quick Start](#quick-start)
|
|
* [Contributing](#contributing)
|
|
* [Code of Conduct](#code-of-conduct)
|
|
* [License](#license)
|
|
|
|
## 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/7.8.2/video-js.min.css" rel="stylesheet">
|
|
<script src="//vjs.zencdn.net/7.8.2/video.min.js"></script>
|
|
```
|
|
|
|
> For the latest version of video.js and URLs to use, check out the [Getting Started][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](https://github.com/videojs/cdn/blob/master/src/analytics.js) 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:
|
|
|
|
```html
|
|
<script>window.HELP_IMPROVE_VIDEOJS = false;</script>
|
|
```
|
|
|
|
Alternatively, you can include Video.js by getting it from [npm](https://videojs.com/getting-started/#install-via-npm), downloading from [GitHub releases](https://github.com/videojs/video.js/releases) or by including it via [unpkg](https://unpkg.com) or another JavaScript CDN like CDNjs. These releases _do not_ include Google Analytics tracking at all.
|
|
|
|
```html
|
|
<!-- 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@7.8.2/dist/video-js.min.css" rel="stylesheet">
|
|
<script src="https://unpkg.com/video.js@7.8.2/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/7.8.1/video-js.min.css" rel="stylesheet">
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/video.js/7.8.1/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][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="https://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._
|
|
|
|
## [Code of Conduct][coc]
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
|
|
|
|
## [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]: https://docs.videojs.com
|
|
|
|
[fastly]: https://www.fastly.com/
|
|
|
|
[getting-started]: https://videojs.com/getting-started/
|
|
|
|
[license]: LICENSE
|
|
|
|
[logo]: https://videojs.com/logo-white.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]: https://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=main
|
|
|
|
[travis-link]: https://travis-ci.org/videojs/video.js
|
|
|
|
[vjs]: https://videojs.com
|
|
|
|
[coc]: CODE_OF_CONDUCT.md
|