[comment]: <> ([](https://saucelabs.com/u/robwalch))
!HLS.js
HLS.js is a JavaScript library that implements an [HTTP Live Streaming] client. It relies on [HTML5 video][] and [MediaSource Extensions][] for playback, and on [Managed Media Source][] where MSE is not available (Safari on iOS 17.1+).
It streams VOD, Live, and Low-Latency HLS assets made up of fragmented MP4 (fMP4), MPEG-2 Transport Stream, or Packed Audio segments. fMP4 segments (ISO BMFF, including CMAF) are passed through to MSE without remuxing, while MPEG-2 TS and Packed Audio (AAC, MP3, and AC-3) segments are transmuxed into fMP4. Transmuxing is performed asynchronously using a [Web Worker] when available in the browser.
HLS.js streams media into a standard HTML element, which handles decoding, rendering, playback, and seeking.
Control playback through the [HTMLMediaElement] API, and use HLS.js to load assets, choose quality levels and tracks, and listen for streaming events.
For assets with Interstitials, use hls.interstitialsManager to seek and track position on the integrated timeline of primary content and interstitial breaks.
HLS.js is written in [TypeScript] and transpiled using [Babel] to ECMAScript 5 syntax for the UMD bundles, and to native ES module syntax for the ESM bundles.
The [TypeScript compiler] and [API Extractor] are used for type checking and to generate the hls.d.ts type declarations.
[Rollup] is used to build the distro bundles and, in watch mode, the local development environment. Each release includes:
fullandlightbuilds. The light build leaves out optional features such as alternate audio, subtitles, EME (DRM), CMCD, and Interstitials to reduce size (see Build tasks).- UMD bundles (
hls.js,hls.light.js) fortags andrequire. They target browsers as old as Chrome 47, Firefox 51, and Safari 10, and inline the transmuxer worker. - ESM bundles (
hls.mjs,hls.light.mjs) forimportand modern bundlers. They do not inline the worker; setworkerPathto the publishedhls.worker.jsto transmux off the main thread.
[html5 video]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video
[htmlmediaelement]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement
[mediasource extensions]: https://w3c.github.io/media-source/
[managed media source]: https://developer.mozilla.org/en-US/docs/Web/API/ManagedMediaSource
[http live streaming]: https://datatracker.ietf.org/doc/html/draft-pantos-hls-rfc8216bis
[web worker]: https://caniuse.com/#search=worker
[typescript]: https://www.typescriptlang.org/
[babel]: https://babeljs.io/
[typescript compiler]: https://www.typescriptlang.org/docs/handbook/compiler-options.html
[api extractor]: https://api-extractor.com/
[rollup]: https://rollupjs.org/
Features
- VOD & Live playlists
- Fragmented MP4 container
SUPPLEMENTAL-CODECS attribute for codec selection
- MPEG-2 TS container
- AAC container (audio-only segments)
- MPEG Audio container (MPEG-1/2 Audio Layer III audio-only segments)
- Timed Metadata for HTTP Live Streaming (ID3 format carried in MPEG-2 TS, Emsg in CMAF/Fragmented MP4, and DATERANGE playlist tags)
enableEmsgKLVMetadata)
- AES-128, AES-256, and AES-256-CTR decryption
- "identity" format SAMPLE-AES decryption of MPEG-2 TS segments only
- Encrypted media extensions (EME) support for DRM (digital rights management)
- Level capping based on HTMLMediaElement resolution, dropped-frames, and HDCP-Level
- CEA-608/708 captions
- WebVTT subtitles
- IMSC1 (TTML) subtitles, limited to the text profile and a subset of TTML styling
- Adaptive streaming
- Alternate Audio Track Rendition (Multivariant Playlist with Alternative Audio) for VoD and Live playlists
- HLS Interstitials (ad insertion and content replacement scheduled with DATERANGE tags)
- I-frame trick-play, including image I-frame (
mjpg) renditions - Accurate Seeking on VoD & Live (not limited to fragment or keyframe boundary)
- Ability to seek in buffer and back buffer without redownloading segments
- Built-in Analytics
- Content Steering
- Resilience to errors
- Redundant/Failover Playlists
- HLS Variable Substitution
Supported HLS tags
For details on the HLS format and these tags' meanings, see https://datatracker.ietf.org/doc/html/draft-pantos-hls-rfc8216bis
Multivariant Playlist tags
#EXT-X-STREAM-INF:
#EXT-X-I-FRAME-STREAM-INFI-frame Media Playlist files#EXT-X-MEDIA:#EXT-X-SESSION-DATA:#EXT-X-SESSION-KEY:EME Key-System selection and preloading#EXT-X-START:TIME-OFFSET=#EXT-X-CONTENT-STEERING:Content Steering#EXT-X-DEFINE:Variable Substitution (NAME,VALUE,QUERYPARAMattributes)
Media Playlist tags
#EXTM3U(required format identifier)#EXT-X-VERSION:(value is ignored)#EXT-X-INDEPENDENT-SEGMENTS(ignored)#EXT-X-I-FRAMES-ONLY#EXTINF:,[ ] #EXT-X-ENDLIST#EXT-X-PLAYLIST-TYPE:(see "Not Supported" below)#EXT-X-MEDIA-SEQUENCE:#EXT-X-TARGETDURATION:#EXT-X-DISCONTINUITY#EXT-X-DISCONTINUITY-SEQUENCE:#EXT-X-BITRATE:#EXT-X-BYTERANGE:[@ ] #EXT-X-MAP:#EXT-X-KEY:(KEYFORMAT="identity",METHOD=SAMPLE-AESis only supported with MPEG-2 TS segments)#EXT-X-PROGRAM-DATE-TIME:#EXT-X-START:TIME-OFFSET=#EXT-X-SERVER-CONTROL:#EXT-X-PART-INF:PART-TARGET=#EXT-X-PART:#EXT-X-SKIP:Delta Playlists#EXT-X-RENDITION-REPORT:#EXT-X-DATERANGE:Metadata
#EXT-X-DEFINE:Variable Import and Substitution (NAME,VALUE,IMPORT,QUERYPARAMattributes)#EXT-X-GAP(Skips loading GAP segments and parts. Skips playback of unbuffered program containing only GAP content and no suitable alternates. See #2940)
#EXT-X-PRELOAD-HINT:(See #5074)
Not Supported
For a complete list of issues, see "Top priorities" in the Release Planning and Backlog project tab. Codec support is dependent on the runtime environment (for example, not all browsers on the same OS support HEVC).
- #EXT-X-PLAYLIST-TYPE is not used to determine if media playlists should be reloaded based on "Expires" header value (#7082)
REQ-VIDEO-LAYOUTis not used in variant filtering or selection- "identity" format
SAMPLE-AESmethod keys with fmp4, aac, mp3, vtt... segments (MPEG-2 TS only) - MPEG-2 TS segments with FairPlay Streaming, PlayReady, or Widevine encryption
- FairPlay Streaming legacy keys (For com.apple.fps.1_0 use native Safari playback)
- ClearKey (
org.w3.clearkey) is incomplete: the key system is recognized, but there is no way to supply key ID/key value pairs to the EME controller, so no license or session path exists (See #2934) - EC-3 (Dolby Digital Plus) in MPEG-2 TS and in containerless (audio only) elementary streams. EC-3 is supported in Fragmented MP4 segments
- HEVC and AC-3 in MPEG-2 TS are excluded from the
lightbuild (see__USE_M2TS_ADVANCED_CODECS__)
Server-side-rendering (SSR) and require from a Node.js runtime
You can safely require this library in Node and absolutely nothing will happen. A dummy object is exported so that requiring the library does not throw an error. HLS.js is not instantiable in Node.js. See #1841 for more details.
Getting started with development
First, checkout the repository and install the required dependencies
git clone https://github.com/video-dev/hls.js.git
cd hls.js
After cloning or pulling from the repository, make sure all dependencies are up-to-date
npm install ci
Run dev-server for demo page (recompiles on file-watch, but doesn't write to actual dist fs artifacts)
npm run dev
After making changes run the sanity-check task to verify all checks before committing changes
npm run sanity-check
The dev server will host files on port 8000. Once started, the demo can be found running at http://localhost:8000/demo/.
Before submitting a PR, please see our contribution guidelines. Join the discussion on Slack via video-dev.org in #hlsjs for updates and questions about development.
Build tasks
Build all flavors (suitable for prod-mode/CI):
npm install ci
npm run build
Only debug-mode artifacts:
npm run build:debug
Build and watch (customized dev setups where you'll want to host through another server - for example in a sub-module/project)
npm run build:watch
Only specific flavors (known configs are: full, fullMin, fullEsm, fullEsmMin, light, lightMin, lightEsm, lightEsmMin, worker, demo):
npm run build -- --configType fullMin # repeat --configType to build more than one
Report the size of the built dist/ files, and check them against the budgets in
dist-size-budget.json (the same check CI runs):
npm run size
npm run size:check
NOTE: hls.light.*.js dist files do not include alternate-audio, subtitles, CMCD, EME (DRM), Variable Substitution, Interstitials, I-frame trick-play, Media Capabilities, or MPEG-2 TS advanced codec (HEVC and AC-3) support. Content Steering is included. In addition, the following types are not available in the light build:
AudioStreamControllerAudioTrackControllerCuesInterfaceEMEControllerSubtitleStreamControllerSubtitleTrackControllerTimelineControllerCMCDControllerInterstitialsControllerInterstitialsManagerIFrameControllerHlsIFramesOnlyHlsImageIFramesOnly
Linter (ESlint)
Run linter:
npm run lint
Run linter with auto-fix mode:
npm run lint:fix
Run linter with errors only (no warnings)
npm run lint:quiet
Formatting Code
Run prettier to format code
npm run prettier
Type Check
Run type-check to verify TypeScript types
npm run type-check
Automated tests (Mocha/Karma)
Run all tests at once:
npm test
Run unit tests:
npm run test:unit
Run unit tests in watch mode:
npm run test:unit:watch
Run functional (integration) tests:
npm run test:func
Design
An overview of this project's design, it's modules, events, and error handling can be found here.
API docs and usage guide
- API and usage docs, with code examples
- Auto-Generated API Docs (Latest Release)
- Auto-Generated API Docs (Development Branch)
Demo
Latest Release
https://hlsjs.video-dev.org/demo
Master
https://hlsjs-dev.video-dev.org/demo
Specific Version
Find the commit on https://github.com/video-dev/hls.js/tree/deployments.
This project is tested with BrowserStack. This project is tested with SauceLabs.
Compatibility
HLS.js is only compatible with browsers supporting MediaSource extensions (MSE) API with 'video/MP4' mime-type inputs.
HLS.js is supported on:
- Chrome 47+ for Desktop
- Firefox 51+ for Desktop
- Edge for Windows 10+
- Safari 10+ for macOS 10.11+
- Safari for iPadOS 13+
- Safari for iOS 17.1+ since HLS version 1.5.0 using Managed Media Source (MMS) WebKit blog
- Chrome for Android 5+
- Firefox for Android 5+
@babel/preset-env when building the UMD bundles in dist/. They share an ES2016 runtime baseline: ES5-style syntax plus native ES2016 globals (Map, Set, Promise, Array.from, Uint8Array.from, Array.prototype.includes, etc.). To keep bundle size small, no core-js polyfills are bundled.
Optional features such as CMCD pull in ES2017 APIs (e.g. Object.entries), so the full UMD bundle effectively requires an ES2017-capable runtime. The light bundle excludes those features and stays at the ES2016 baseline.
The dist/ folder ships two distribution variants:
- UMD (
dist/hls.js,dist/hls.min.js,dist/hls.light.js,dist/hls.light.min.js) — embeddable directly via atag (exposes a globalHls) or resolved byrequire('hls.js')viapackage.json'smainfield. Targets the browser list above. The companiondist/hls.worker.jsis the bundled transmuxer Web Worker. - ESM (
dist/hls.mjs,dist/hls.light.mjs, plus the minifieddist/hls.min.mjsanddist/hls.light.min.mjs) —import 'hls.js'resolves to the unminifieddist/hls.mjsvia themodulefield, which is what you want when a bundler will minify it for you. The.min.mjsfiles exist for loading straight from a CDN with. Built with@babel/preset-env'sesmodules: truetarget (≈ Chrome 61+, Firefox 60+, Safari 10.1+, Edge 16+) and intended to be consumed by a modern bundler. Uses ES2015+ syntax but stays below ES2019 (noArray.prototype.flatMap,Object.fromEntries, etc.).
The ESM builds do not bundle the transmuxer Web Worker. The UMD builds inline it, butdist/hls.mjsanddist/hls.min.mjsdo not, so transmuxing runs on the main thread unless you pointworkerPathat the separately published worker:
>> workerPath: 'https://cdn.jsdelivr.net/npm/hls.js@1/dist/hls.worker.js', > }); >> const hls = new Hls({
If you import from src/ directly or include any of our runtime dependencies untranspiled in your own build, you bypass this Babel pipeline and become responsible for transpilation; those source modules can reach for ES2019+ APIs that are tree-shaken out of the bundles we publish.
To run on browsers below this baseline, supply your own polyfills for any missing globals before HLS.js loads.
Please note:
Safari browsers (iOS, iPadOS, and macOS) have built-in HLS support through the plain video "tag" source URL. See the example below (Using HLS.js) to run appropriate feature detection and choose between using HLS.js or natively built-in HLS support.
When a platform has neither MediaSource nor native HLS support, the browser cannot play HLS.
_Keep in mind that if the intention is to support HLS on multiple platforms, beyond those compatible with HLS.js, HLS assets need to strictly follow the specifications of RFC8216, especially if apps, smart TVs, and set-top boxes are to be supported._
Find a support matrix of the MediaSource API here: https://developer.mozilla.org/en-US/docs/Web/API/MediaSource
Using HLS.js
Installation
Prepackaged builds are included with each release. Or install the hls.js as a dependency of your project:
npm install --save hls.js
A canary channel is also available if you prefer to work off the development branch (master):
npm install hls.js@canary
Embedding HLS.js
Directly include dist/hls.js or dist/hls.min.js in a script tag on the page. This setup prioritizes streaming with HLS.js and MSE over native browser support for HLS playback in HTMLMediaElements:
<script src="https://cdn.jsdelivr.net/npm/hls.js@1"></script>
<!-- Or if you want the latest version from the main branch -->
<!-- <script src="https://cdn.jsdelivr.net/npm/hls.js@canary"></script> -->
<video id="video"></video>
<script>
var video = document.getElementById('video');
var videoSrc = 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8';
if (Hls.isSupported()) {
var hls = new Hls();
hls.loadSource(videoSrc);
hls.attachMedia(video);
}
// HLS.js is not supported on platforms that do not have Media Source
// Extensions (MSE) enabled.
//
// When the browser has built-in HLS support (check using canPlayType),
// we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video
// element through the src property. This is using the built-in support
// of the plain video element, without using HLS.js.
else if (video.canPlayType('application/vnd.apple.mpegurl')) {
video.src = videoSrc;
}
</script>
Alternative setup
To check for native browser support first and then fallback to HLS.js, swap these conditionals.
Note:video.canPlayType('application/vnd.apple.mpegurl')returns a non-empty string ("maybe") in Safari, Chrome, and potentially other browsers. However, not all browsers support HLS content equally — for example, Chrome 147 reports support but may fail to play certain assets natively. UsingHls.isSupported()first (the default setup above) is recommended unless you specifically need native playback.
<script src="https://cdn.jsdelivr.net/npm/hls.js@1"></script>
<!-- Or if you want the latest version from the main branch -->
<!-- <script src="https://cdn.jsdelivr.net/npm/hls.js@canary"></script> -->
<video id="video"></video>
<script>
var video = document.getElementById('video');
var videoSrc = 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8';
//
// Only use native HLS in browsers with ManagedMediaSource (e.g. modern Safari)
// where native playback is well-supported. Other browsers may report HLS support
// via canPlayType but fail to play certain assets reliably.
//
if (
video.canPlayType('application/vnd.apple.mpegurl') &&
'ManagedMediaSource' in window
) {
video.src = videoSrc;
//
// If not using native HLS, check if HLS.js is supported
//
} else if (Hls.isSupported()) {
var hls = new Hls();
hls.loadSource(videoSrc);
hls.attachMedia(video);
}
</script>
Ensure correct time in video
HLS transcoding of an original video file often pushes the time of the first frame a bit. If you depend on having an exact match of frame times between original video and HLS asset, you need to account for this:
let tOffset = 0;
const getAppendedOffset = (eventName, { frag }) => {
if (frag.type === 'main' && frag.sn !== 'initSegment' && frag.elementaryStreams.video) {
const { start, startDTS, startPTS, maxStartPTS, elementaryStreams } = frag;
tOffset = elementaryStreams.video.startPTS - start;
hls.off(Hls.Events.BUFFER_APPENDED, getAppendedOffset);
console.log('video timestamp offset:', tOffset, { start, startDTS, startPTS, maxStartPTS, elementaryStreams });
}
}
hls.on(Hls.Events.BUFFER_APPENDED, getAppendedOffset);
// and account for this offset, for example like this:
const video = document.querySelector('video');
video.addEventListener('timeupdate', () => setTime(Math.max(0, video.currentTime - tOffset))
const seek = (t) => video.currentTime = t + tOffset;
const getDuration = () => video.duration - tOffset;
For more embed and API examples see docs/API.md.
CORS
All HLS resources must be delivered with CORS headers permitting GET requests.
Video Control
Video is controlled through HTML element HTMLVideoElement methods, events and optional UI controls ().
Build a Custom UI
Player Integration
The following players integrate HLS.js for HLS playback:
- JW Player
- Akamai Adaptive Media Player (AMP)
- BridTV Player
- Clappr
- Flowplayer through flowplayer-hlsjs
- MediaElement.js
- KalturaPlayer through kaltura-player-js
- Videojs through Videojs-hlsjs
- Videojs through videojs-hls.js. hls.js is integrated as a SourceHandler -- new feature in Video.js 5.
- Videojs through videojs-contrib-hls.js. Production ready plug-in with full fallback compatibility built-in.
- Fluid Player
- OpenPlayerJS, as part of the OpenPlayer project
- CDNBye, a p2p engine for hls.js powered by WebRTC Datachannel.
- ArtPlayer
They use HLS.js in production!
| | | | |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
| |
| |
|
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
| |
|
|
|
|
|
|
| |
| |
|
|
| |
|
|
| cdn77 | |
| |
|
|
| |
|
|
| | | |
Chrome/Firefox integration
made by gramk, plays hls from address bar and m3u8 links
- Chrome native-hls
- Firefox native-hls
License
HLS.js is released under Apache 2.0 License