Name: hls.js
Owner: video-dev
Description: JavaScript HLS client using Media Source Extension
Created: 2015-01-30 09:06:27.0
Updated: 2018-01-19 07:11:23.0
Pushed: 2018-01-18 23:43:40.0
Homepage: http://video-dev.github.io/hls.js/demo
Size: 37025
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Join the discussion on Slack#hlsjs 
hls.js is a JavaScript library which implements an HTTP Live Streaming client. It relies on HTML5 video and MediaSource Extensions for playback.
It works by transmuxing MPEG-2 Transport Stream and AAC/MP3 streams into ISO BMFF (MP4) fragments. This transmuxing could be performed asynchronously using Web Worker if available in the browser. hls.js also supports HLS + fmp4, as announced during WWDC2016
hls.js does not need any player, it works directly on top of a standard HTML`<video>`element.
hls.js is written in ECMAScript6, and transpiled in ECMAScript5 using Babel.
API and code documention: http://video-dev.github.io/hls.js/docs/html
Find a more detailed library usage guide, use-cases and example here
http://video-dev.github.io/hls.js/demo
ipt src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
eo id="video"></video>
ipt>
(Hls.isSupported()) {
var video = document.getElementById('video');
var hls = new Hls();
hls.loadSource('https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8');
hls.attachMedia(video);
hls.on(Hls.Events.MANIFEST_PARSED,function() {
video.play();
;
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 throught the `src` property.
This is using the built-in support of the plain video element, without using hls.js.
se if (video.canPlayType('application/vnd.apple.mpegurl')) {
video.src = 'https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8';
video.addEventListener('canplay',function() {
video.play();
});
ript>
Video is controlled through HTML `<video>` element.
HTMLVideoElement control and events could be used seamlessly.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
hls.js is (being) integrated in the following players:
made by gramk, plays hls from address bar and m3u8 links
No external JS libs are needed. Prepackaged build is included in the dist folder:
If you want to bundle the application yourself, use node
install hls.js
NOTE: hls.light.*.js dist files do not include subtitling and alternate-audio features.
Either directly include dist/hls.js or dist/hls.min.js
Or type
install --save hls.js
Optionally there is a declaration file available to help with code completion and hinting within your IDE for the hls.js api
install --save-dev @types/hls.js
hls.js is compatible with browsers supporting MediaSource extensions (MSE) API with 'video/MP4' mimetypes inputs.
Find a support matrix of the MediaSource API here: https://developer.mozilla.org/en-US/docs/Web/API/MediaSource
As of today, it is supported on:
Please note: iOS Safari “Mobile” does not support the MediaSource API. Safari browsers have however built-in HLS support through the plain video “tag” source URL. See the example above (Getting Started) 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, you will not be able to play HLS.
All HLS resources must be delivered with CORS headers permitting GET requests.
#EXTM3U#EXTINF#EXT-X-STREAM-INF (adaptive streaming)#EXT-X-ENDLIST (Live playlist)#EXT-X-MEDIA-SEQUENCE#EXT-X-TARGETDURATION#EXT-X-DISCONTINUITY#EXT-X-DISCONTINUITY-SEQUENCE#EXT-X-BYTERANGE#EXT-X-MAP#EXT-X-KEY (https://tools.ietf.org/html/draft-pantos-http-live-streaming-08#section-3.4.4)#EXT-X-PROGRAM-DATE-TIME (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.2.6)EXT-X-START:TIME-OFFSET=x (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.5.2)hls.js is released under Apache 2.0 License
Pull requests are welcome. Here is a quick guide on how to start.
clone https://github.com/video-dev/hls.js.git
tup dev environement
ls.js
install
ild dist/hls.js, watch file change for rebuild and launch demo page
run dev
nt
run lint
.editorconfig file.dist/hls.js file in your PR. We'll take care of generating an updated build right before releasing a new tagged version.Click here for details.
