1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-23 02:04:34 +02:00
Video.js - open source HTML5 video player
Go to file
hugorogz e767053049
feat: export more helpers in videojs object (#7717)
Co-authored-by: Hugo Rodriguez <hrodriguez@brightcove.com>
Co-authored-by: Pat O'Neill <pgoneill@gmail.com>
2022-05-10 15:57:58 -04:00
.github chore: use aws s3 cp rather than sync (#7400) 2021-08-25 16:52:51 -04:00
build docs: Redirect guides to videojs.com (#7706) 2022-04-06 11:34:18 -04:00
docs docs: Redirect guides to videojs.com (#7706) 2022-04-06 11:34:18 -04:00
lang feat: Add Basque (eu) translations (#7625) 2022-03-02 10:44:04 -05:00
sandbox chore(sandbox): update embeds media to use public url (#7530) 2021-11-16 12:20:01 -05:00
src feat: export more helpers in videojs object (#7717) 2022-05-10 15:57:58 -04:00
test chore: Update preset env, drop IE11 and older browser support (#7708) 2022-05-05 10:32:13 -04:00
.babelrc chore: Update preset env, drop IE11 and older browser support (#7708) 2022-05-05 10:32:13 -04:00
.browserslistrc chore: Update preset env, drop IE11 and older browser support (#7708) 2022-05-05 10:32:13 -04:00
.editorconfig Added .editorconfig and travis CI badge 2012-12-11 14:33:42 -08:00
.gitignore chore: netlify ci demo and docs (#7045) 2021-01-19 18:47:48 -05:00
.jsdoc.json fix: broken logo link in README and docs (#6345) 2019-12-03 10:14:38 -05:00
.npmignore feat: add core ES module. (#6287) 2019-11-15 13:44:11 -05:00
.nvmrc chore: update node/nvmrc and various dependencies (#7221) 2021-05-04 11:45:59 -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
CHANGELOG.md 7.19.0 2022-03-21 14:37:50 -04:00
CODE_OF_CONDUCT.md docs(coc): introduce CODE_OF_CONDUCT.md (#4160) 2017-03-23 16:39:17 -04:00
COLLABORATOR_GUIDE.md chore: fix typo in COLLABORATOR_GUIDE (#7537) 2021-11-30 00:40:59 -05:00
composer.json docs: Remove Flash (#6994) 2020-12-22 14:10:53 -05:00
CONTRIBUTING.md docs: Fix typo in CONTRIBUTING.md (#7260) 2021-06-04 12:27:11 -04:00
index.html feat: Add a player option noUITitleAttributes to prevent title attributes in the UI (#7134) 2021-03-23 17:47:16 -04:00
LICENSE More build and testing cleanup. Also some reorganization. 2015-04-02 11:33:51 -07:00
package-lock.json chore: update karma-config to 8 to drop ie11 and older browsers (#7547) 2022-04-07 09:44:46 -04:00
package.json chore: update karma-config to 8 to drop ie11 and older browsers (#7547) 2022-04-07 09:44:46 -04:00
postcss.config.js chore: Update preset env, drop IE11 and older browser support (#7708) 2022-05-05 10:32:13 -04:00
README.md docs: change master to main (#7050) 2021-01-19 17:41:39 -05:00
rollup.config.js chore: Update preset env, drop IE11 and older browser support (#7708) 2022-05-05 10:32:13 -04:00

Video.js logo

Video.js - HTML5 Video Player

Build Status Coverage Status Greenkeeper badge Slack Status

NPM

Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 video and Media Source Extensions, as well as other playback techs like 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 600,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/7.10.2/video-js.min.css" rel="stylesheet">
<script src="//vjs.zencdn.net/7.10.2/video.min.js"></script>

For the latest version of video.js and URLs to use, check out the 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 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 : 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.10.2/dist/video-js.min.css" rel="stylesheet">
<script src="https://unpkg.com/video.js@7.10.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.10.2/video-js.min.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/video.js/7.10.2/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 - 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="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:

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.