video.js HLS Source Handler 
Play back HLS with video.js, even where it's not natively supported.
Lead Maintainer: Jon-Carlos Rivera @imbcmdth
Maintenance Status: Stable
Table of Contents generated with DocToc
- Installation
- Contributing
- Getting Started
- Known Issues
- Documentation
- Hosting Considerations
- Release History
- Building
- Development
Installation
NPM
To install videojs-contrib-hls with npm run
npm install --save videojs-contrib-hls
CDN
Select a version of HLS from the CDN
Releases
Download a release of videojs-contrib-hls
Manual Build
Download a copy of this git repository and then follow the steps in Building
Contributing
See CONTRIBUTING.md
Getting Started
Get a copy of videojs-contrib-hls and include it in your page along with video.js:
<video id=example-video width=600 height=300 class="video-js vjs-default-skin" controls>
<source
src="https://example.com/index.m3u8"
type="application/x-mpegURL">
</video>
<script src="video.js"></script>
<script src="videojs-contrib-hls.min.js"></script>
<script>
var player = videojs('example-video');
player.play();
</script>
Check out our live example if you're having trouble.
Known Issues
Issues that are currenty know about with workarounds. If you want to help find a solution that would be appreciated!
IE11
In some IE11 setups there are issues working with it's native HTML SourceBuffers functionality. This leads to various issues, such as videos stopping playback with media decode errors. The known workaround for this issues is to force the player to use flash when running on IE11.
Documentation
HTTP Live Streaming (HLS) has become a de-facto standard for streaming video on mobile devices thanks to its native support on iOS and Android. There are a number of reasons independent of platform to recommend the format, though:
- Supports (client-driven) adaptive bitrate selection
- Delivered over standard HTTP ports
- Simple, text-based manifest format
- No proprietary streaming servers required
Unfortunately, all the major desktop browsers except for Safari are missing HLS support. That leaves web developers in the unfortunate position of having to maintain alternate renditions of the same video and potentially having to forego HTML-based video entirely to provide the best desktop viewing experience.
This project addresses that situation by providing a polyfill for HLS on browsers that have support for Media Source Extensions, or failing that, support Flash. You can deploy a single HLS stream, code against the regular HTML5 video APIs, and create a fast, high-quality video experience across all the big web device categories.
Check out the full documentation for details on how HLS works and advanced configuration. A description of the adaptive switching behavior is available, too.
videojs-contrib-hls support a bunch of HLS v2 and v3 features. Here are some highlights:
- video-on-demand and live playback modes
- backup or redundant streams
- mid-segment quality switching
- AES-128 segment encryption
- CEA-608 captions are automatically translated into standard HTML5 caption text tracks
- Timed ID3 Metadata is automatically translated into HTML5 metedata text tracks
- Highly customizable adaptive bitrate selection
- Automatic bandwidth tracking
- Cross-domain credentials support with CORS
- Tight integration with video.js and a philosophy of exposing as much as possible with standard HTML APIs
- Stream with multiple audio tracks and switching to those audio tracks (see the docs folder) for info
Options
How to use
Initialization
You may pass in an options object to the hls source handler at player initialization. You can pass in options just like you would for other parts of video.js:
// html5 for html hls
videojs(video, {html5: {
hls: {
withCredentials: true
}
}});
// or
// flash for flash hls
videojs(video, {flash: {
hls: {
withCredentials: true
}
}});
// or
var options = {hls: {
withCredentials: true;
}};
videojs(video, {flash: options, html5: options});
Source
Some options, such as withCredentials can be passed in to hls during
player.src
var player = videojs('some-video-id');
player.src({
src: "http://solutions.brightcove.com/jwhisenant/hls/apple/bipbop/bipbopall.m3u8",
type: 'application/x-mpegURL',
withCredentials: true
});
List
withCredentials
- Type:
boolean - can be used as a source option
- can be used as an initialization option
When the withCredentials property is set to true, all XHR requests for
manifests and segments would have withCredentials set to true as well. This
enables storing and passing cookies from the server that the manifests and
segments live on. This has some implications on CORS because when set, the
Access-Control-Allow-Origin header cannot be set to *, also, the response
headers require the addition of Access-Control-Allow-Credentials header which
is set to true.
See html5rocks's article
for more info.
useCueTags
- Type:
boolean - can be used as an initialization option
When the useCueTags property is set to true, a text track is created with
label 'ad-cues' and kind 'metadata'. The track is then added to
player.textTracks(). Changes in active cue may be
tracked by following the Video.js cue points API for text tracks. For example:
let textTracks = player.textTracks();
let cuesTrack;
for (let i = 0; i < textTracks.length; i++) {
if (textTracks[i].label === 'ad-cues') {
cuesTrack = textTracks[i];
}
}
cuesTrack.addEventListener('cuechange', function() {
let activeCues = cuesTrack.activeCues;
for (let i = 0; i < activeCues.length; i++) {
let activeCue = activeCues[i];
console.log('Cue runs from ' + activeCue.startTime +
' to ' + activeCue.endTime);
}
});
Runtime Properties
Runtime properties are attached to the tech object when HLS is in use. You can get a reference to the HLS source handler like this:
var hls = player.tech({ IWillNotUseThisInPlugins: true }).hls;
If you were thinking about modifying runtime properties in a video.js plugin, we'd recommend you avoid it. Your plugin won't work with videos that don't use videojs-contrib-hls and the best plugins work across all the media types that video.js supports. If you're deploying videojs-contrib-hls on your own website and want to make a couple tweaks though, go for it!
hls.playlists.master
Type: object
An object representing the parsed master playlist. If a media playlist is loaded directly, a master playlist with only one entry will be created.
hls.playlists.media
Type: function
A function that can be used to retrieve or modify the currently active media playlist. The active media playlist is referred to when additional video data needs to be downloaded. Calling this function with no arguments returns the parsed playlist object for the active media playlist. Calling this function with a playlist object from the master playlist or a URI string as specified in the master playlist will kick off an asynchronous load of the specified media playlist. Once it has been retreived, it will become the active media playlist.
hls.segmentXhrTime
Type: number
The number of milliseconds it took to download the last media segment. This value is updated after each segment download completes.
hls.bandwidth
Type: number
The number of bits downloaded per second in the last segment download.
This value is used by the default implementation of selectPlaylist
to select an appropriate bitrate to play.
Before the first video segment has been downloaded, it's hard to estimate bandwidth accurately. The HLS tech uses a heuristic based on the playlist download times to do this estimation by default. If you have a more accurate source of bandwidth information, you can override this value as soon as the HLS tech has loaded to provide an initial bandwidth estimate.
hls.bytesReceived
Type: number
The total number of content bytes downloaded by the HLS tech.
hls.selectPlaylist
Type: function
A function that returns the media playlist object to use to download
the next segment. It is invoked by the tech immediately before a new
segment is downloaded. You can override this function to provide your
adaptive streaming logic. You must, however, be sure to return a valid
media playlist object that is present in player.hls.master.
Overridding this function with your own is very powerful but is overkill for many purposes. Most of the time, you should use the much simpler function below to selectively enable or disable a playlist from the adaptive streaming logic.
hls.representations
Type: function
To get all of the available representations, call the representations() method on player.hls. This will return a list of plain objects, each with width, height, bandwidth, and id properties, and an enabled() method.
player.hls.representations();
To see whether the representation is enabled or disabled, call its enabled() method with no arguments. To set whether it is enabled/disabled, call its enabled() method and pass in a boolean value. Calling <representation>.enabled(true) will allow the adaptive bitrate algorithm to select the representation while calling <representation>.enabled(false) will disallow any selection of that representation.
Example, only enabling representations with a width greater than or equal to 720:
player.hls.representations().forEach(function(rep) {
if (rep.width >= 720) {
rep.enabled(true);
} else {
rep.enabled(false);
}
});
hls.xhr
Type: function
The xhr function that is used by HLS internally is exposed on the per-
player hls object. While it is possible, we do not recommend replacing
the function with your own implementation. Instead, the xhr provides
the ability to specify a beforeRequest function that will be called
with an object containing the options that will be used to create the
xhr request.
Example:
player.hls.xhr.beforeRequest = function(options) {
options.uri = options.uri.replace('example.com', 'foo.com');
return options;
};
The global videojs.Hls also exposes an xhr property. Specifying a
beforeRequest function on that will allow you to intercept the options
for all requests in every player on a page.
Example
videojs.Hls.xhr.beforeRequest = function(options) {
/*
* Modifications to requests that will affect every player.
*/
return options;
};
For information on the type of options that you can modify see the documentation at https://github.com/Raynos/xhr.
Events
Standard HTML video events are handled by video.js automatically and are triggered on the player object. In addition, there are a couple specialized events you can listen to on the HLS object during playback:
loadedmetadata
Fired after the first segment is downloaded for a playlist. This will not happen
until playback if video.js's metadata setting is none
loadedplaylist
Fired immediately after a new master or media playlist has been downloaded. By default, the tech only downloads playlists as they are needed.
mediachange
Fired when a new playlist becomes the active media playlist. Note that the actual rendering quality change does not occur simultaneously with this event; a new segment must be requested and the existing buffer depleted first.
In-Band Metadata
The HLS tech supports timed metadata embedded as ID3 tags. When a stream is encountered with embedded metadata, an in-band metadata text track will automatically be created and populated with cues as they are encountered in the stream. UTF-8 encoded TXXX and WXXX ID3 frames are mapped to cue points and their values set as the cue text. Cues are created for all other frame types and the data is attached to the generated cue:
cue.value.data
There are lots of guides and references to using text tracks around the web.
Hosting Considerations
Unlike a native HLS implementation, the HLS tech has to comply with the browser's security policies. That means that all the files that make up the stream must be served from the same domain as the page hosting the video player or from a server that has appropriate CORS headers configured. Easy instructions are available for popular webservers and most CDNs should have no trouble turning CORS on for your account.
Testing
For testing, you run npm run test. This will run tests using any of the
browsers that karma-detect-browsers detects on your machine.
Release History
Check out the changelog for a summary of each release.
Building
To build a copy of videojs-contrib-hls run the following commands
git clone https://github.com/videojs/videojs-contrib-hls
cd videojs-contrib-hls
npm i
npm run build
videojs-contrib-hls will have created all of the files for using it in a dist folder
Development
Tools
- Download stream locally with the HLS Fetcher
- Simulate errors with Murphy
Commands
All commands for development are listed in the package.json file and are run using
npm run <command>