Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nurrony/hlsdownloader
Downloads HLS Playlist file and TS chunks. You can use it for content pre-fetching from CDN to Edge Server for your end viewers.
https://github.com/nurrony/hlsdownloader
cdn-priming chunk download download-playlists downloader hls hlsdownloader live livestream streaming streaming-video
Last synced: 4 months ago
JSON representation
Downloads HLS Playlist file and TS chunks. You can use it for content pre-fetching from CDN to Edge Server for your end viewers.
- Host: GitHub
- URL: https://github.com/nurrony/hlsdownloader
- Owner: nurrony
- License: mit
- Created: 2015-05-16T09:04:28.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T15:37:01.000Z (9 months ago)
- Last Synced: 2024-05-20T18:43:39.429Z (9 months ago)
- Topics: cdn-priming, chunk, download, download-playlists, downloader, hls, hlsdownloader, live, livestream, streaming, streaming-video
- Language: JavaScript
- Homepage: https://nurrony.github.io/hlsdownloader/
- Size: 1.24 MB
- Stars: 102
- Watchers: 7
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://nurrony.github.io/hlsdownloader/)
Downloads HLS Playlist file and TS chunks. You can use it for content pre-fetching from CDN to Edge Server for your end viewers.
NPM • Documentation • GitHub
[](https://www.npmjs.com/package/hlsdownloader)
[](https://www.npmjs.com/package/hlsdownloader)
[](https://github.com/nurrony/hlsdownloader/actions/workflows/test.yaml)
[](https://nurrony.github.io/hlsdownloader)
[ ](https://github.com/nurrony/hlsdownloader/graphs/commit-activity)
[ ](https://github.com/nurrony/hlsdownloader/blob/master/LICENSE)
[ ](https://npmjs.com/package/hlsdownloader)
[ ](https://npm-stat.com/charts.html?package=hlsdownloader)
[ ](https://bundlephobia.com/package/hlsdownloader@latest)
[](https://snyk.io/test/github/nurrony/hlsdownloader)
> ⚠️
> This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and no longer provides a CommonJS export. If your project uses CommonJS, you will have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). Please don't open issues for questions regarding CommonJS / ESM.
> ⚠️
> HLSDownloader `v2.x.x` is no longer maintained and we will not accept any backport requests.
## Features
- Retryable
- Promise Based
- Support for HTTP/2
- Overwrite protection
- Support for custom HTTP Headers
- Support for custom HTTP Client
- Bring your own progress bar during download
- Concurrent download segments with multiple http connections
## Prerequisites
- node >=18.x.x
## Installation
It is pretty straight forward
```sh
# using npm
npm install --save hlsdownloader
# or with yarn
yarn add hlsdownloader
# or pnpm
pnpm install hlsdownloader
```
## How to use
`destination` field is optional. If `destination` is not provided it just fetches the content from origin.
It can also be useful if you want to do content pre-fetching from CDN for your end viewers. If any `TS` or `m3u8`
variant download is failed it continues downloading others and reports after finishing.
It's simple as below with.
```js
import HLSDownloader from 'hlsdownloader';
const options = {
playlistURL: 'http://example.com/path/to/your/playlist.m3u8', // change it
destination: '/tmp', // change it (optional: default '')
concurrency: 10, // change it (optional: default = 1),
overwrite: true, // change it (optional: default = false)
// (optional: default = null
onData: function (data) {
console.log(data); // {url: "", totalItems: "", path: ""}
},
// (optional: default = null
onError: function (error) {
console.log(error); // { url: "", name: "", message: "human readable message of error" }
},
};
const downloader = new HLSDownloader(options);
downloader.startDownload().then(response => console.log(response));
```
> ℹ️ Check [example.js](example.js) for working example
```js
// on success
{
total: ,
playlistURL: 'your playlist url'
message: 'Downloaded successfully',
}
// on partial download
{
total: ,
playlistURL: 'your playlist url',
message: 'Download done with some errors',
errors: [
{
name: 'InvalidPlaylist',
message: 'Playlist parsing is not successful'
url: 'https://cnd.hls-server.test/playlist.m3u8'
}
] // items url that is skipped or could not downloaded for error
}
```
## Advance Usage
HLSDownloader supports all [Ky API](https://github.com/sindresorhus/ky?tab=readme-ov-file#api) except these options given below
- uri
- url
- json
- form
- body
- method
- setHost
- isStream
- parseJson
- prefixUrl
- cookieJar
- playlistURL
- concurrency
- allowGetBody
- stringifyJson
- methodRewriting
It also disable retry failed request that you can easily override
## Running Tests
```sh
npm test
```
To run it on watch mode
```sh
npm run test:watch
```
## Generate Documentations
```sh
npm docs:gen
```
## Authors
👤 **Nur Rony**
- Website: [nurrony.github.io](https://nurrony.github.io)
- Twitter: [@nmrony](https://twitter.com/nmrony)
- Github: [@nurrony](https://github.com/nurrony)
- LinkedIn: [@nmrony](https://linkedin.com/in/nmrony)
## Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nurrony/hlsdownloader/issues). You can also take a look at the [contributing guide](https://github.com/nurrony/hlsdownloader/blob/master/CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!. I will be grateful if you all help me to improve this package by giving your suggestions, feature request and pull requests. I am all ears!!
## Special Thanks to
- [Ky Team](https://www.npmjs.com/package/ky)
## License
Copyright © 2024 [Nur Rony](https://github.com/nurrony).
This project is [MIT](https://github.com/nurrony/hlsdownloader/blob/master/LICENSE) licensed.