avivharuzi / m3u8-dln

A complete m3u8 downloader 📺

m3u8-dln

A complete m3u8 downloader 📺

An npm package and CLI tool to download M3U8/HLS streams and merge all the chunks to a MP4 video.

Report Bug · Request Feature

---

📖 Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• License

✨ Features

✅ Vey fast 🏎️

✅ Can be used via CLI or in code

✅ Support http headers in case of authentication

✅ Can download from m3u8 master playlist and all his videos inside or specific one

✅ Can merge video and audio together (works only if the m3u8 master playlist was provided)

✅ Preserve original quality (without encoding)

🎯 Prerequisites

• ffmpeg (ffmpeg will be used as the last step to create the mp4 file)

🛠️ Installation

Using via code (for CLI no need to install locally).

NOTE: The package is using esm modules!

Install the package locally.

npm i m3u8-dln

Basic example.

import { m3u8DLN } from 'm3u8-dln';

await m3u8DLN('https://www.example.com/some-path/master.m3u8', './');

With options.

import { m3u8DLN } from 'm3u8-dln';

const response = await m3u8DLN(
  'https://www.example.com/some-path/master.m3u8',
  './',
  {
    httpHeaders: {}, // HTTP headers that can be pass to the http calls.
    segmentBatch: 8, // The number of segment files to download at the same time.
    streamBatch: 4, // The number of streams to download at the same time.
    streamSelection: {
      // 'all' | 'first-one' | 'last-one' | 'highest-bandwidth' | 'highest-resolution'
      strategy: 'highest-resolution', // Choose what streams to download.
    },
  }
);

console.log(response); // [{ outputFilePaths: ['ced0b1120d6954b6229bbbc12c162c6a_1920x1080_25.mp4'] }]

⚡️ Usage

Using via CLI.

npx m3u8-dln --help

Download example with input.

npx m3u8-dln -i https://www.example.com/some-path/master.m3u8

📜 License

MIT