video.js/docs/guides/embeds.md

How to Embed the Video.js player

Video.js is meant to be an enhacement to the video element in HTML5 so for years, its embed code has been just a <video> element. Video.js then wraps the video element in a div that is used for us to place controls and anything else that's required for the player.

For a long time this was enough. In 2016, "div ingest" was added, it allows the developer to give Video.js a player div to use instead of making it's own. This is partly to help with content reflow but also to help with iOS where you sometimes need to prime the video element and we re-create the video element when we create the player div. However, this is kind of weird to have a <video> element embed with a <div> wrapped around it. So, we built out a new embed, a <video-js> embed.

Below, the three kinds of embeds are detailed.

Embeds

<video> embed

The classic Video.js embed. You can then initialize it via data-setup or via the videojs method.

<!-- via data-setup -->
<video id="vid1" class="video-js" data-setup='{}'>
  <source src="//vjs.zencdn.net/v/oceans.mp4">
</video>

<!-- via code -->
<video id="vid1" class="video-js">
  <source src="//vjs.zencdn.net/v/oceans.mp4">
</video>

const player = videojs('vid1', {});

Player div ingest

The enhanced classic embed. You can also initialize it via data-setup or via videojs method.

<!-- via data-setup -->
<div data-vjs-player>
  <video id="vid1" class="video-js" data-setup='{}'>
    <source src="//vjs.zencdn.net/v/oceans.mp4">
  </video>
</div>

<!-- via code -->
<div data-vjs-player>
  <video id="vid1" class="video-js">
    <source src="//vjs.zencdn.net/v/oceans.mp4">
  </video>
</div>

const player = videojs('vid1', {});

As you can see, it isn't much different from the classic <video> embed. It also does make it easier to work with React.

<video-js> embed

This is the I Can't Believe It's Not Custom Elements embed code. It looks very much like the <video> embed but instead of video it's a video-js embed. This is useful for all the things that the player div ingest is useful for and it matches our library name!

<!-- via data-setup -->
<video-js id="vid1" data-setup='{}'>
  <source src="//vjs.zencdn.net/v/oceans.mp4">
</video-js>

<!-- via code -->
<video-js id="vid1">
  <source src="//vjs.zencdn.net/v/oceans.mp4">
</video-js>

const player = videojs('vid1', {});

Adding class="video-js" with this embed is no longer necessary as it will automatically add the class video-js if missing.

Custom Elements

Native Custom Elements support is relativly small according to Can I Use and because we didn't want to include a polyfill we're going with just an element called video-js rather than a full blown custom element.

Browser support

These all work in all browsers that Video.js supports, though, there are some caveats for some older browsers.

• IE8 requires running document.createElement('video-js') before using the video-js embed code.
• IE9 doesn't support having source elements outside of the video element, thus, the video-js embed will not work there. Though, if the source is set later, it should still work.

data-setup

This is an ease-of-use method for having Video.js set up the player automatically. It is an HTML attribute and it takes a JSON string representation of the player options as the value. Using the programmatic approach is probably preferable.