M3U Parser Generator

Library to parse and generate m3u or m3u8 IPTV playlist files.

Content

• 🚀 Installation
• 📚 Documentation
• 💻 Usage
  • 🌐 Browser
• ⚖️ License

🚀 Installation

Install M3U Parser Generator with npm

1npm install m3u-parser-generator --save

or with jsdelivr

1<script src="https://cdn.jsdelivr.net/npm/m3u-parser-generator@5.0.1/dist/m3u-parser-generator.iife.js"></script>

📚 Documentation

Documentation

💻 Usage

You can parse your loaded m3u string:

1import {M3uParser} from 'm3u-parser-generator';
2
3const parser = new M3uParser();
4const playlist = parser.parse(m3uString);
5playlist.medias.forEach(media => media.location);

and you get object with following structure

1{
2  "title": "Test TV",
3  "medias": [
4    {
5      "location": "http://iptv.test1.com/playlist.m3u8",
6      "duration": -1,
7      "attributes": {
8        "tvg-id": "Test tv 1",
9        "tvg-country": "CZ",
10        "tvg-language": "CS",
11        "tvg-logo": "logo1.png",
12        "group-title": "Test1",
13        "unknown": "0"
14      },
15      "name": "Test tv 1 [CZ]",
16      "group": "Test TV group 1"
17    },
18    {
19      "location": "http://iptv.test2.com/playlist.m3u8",
20      "duration": 100,
21      "attributes": {
22        "tvg-id": "Test tv 2",
23        "tvg-country": "SK",
24        "tvg-language": "SK",
25        "tvg-logo": "logo2.png",
26        "group-title": "Test2"
27      },
28      "name": "Test tv 2 [SK]",
29      "group": "Test TV group 2"
30    },
31    {
32      "location": "http://iptv.test3.com/playlist.m3u8",
33      "duration": 120,
34      "attributes": {
35        "tvg-id": "Test tv 3",
36        "tvg-country": "EN",
37        "tvg-language": "EN",
38        "tvg-logo": "logo3.png",
39        "group-title": "Test3"
40      },
41      "name": "Test tv 3 [EN]"
42    },
43    {
44      "location": "http://iptv.test4.com/playlist.m3u8",
45      "duration": -1,
46      "attributes": {}
47    }
48  ]
49}

Or you can generate new playlist by your own:

1import {M3uPlaylist, M3uMedia} from 'm3u-parser-generator';
2
3const playlist = new M3uPlaylist();
4playlist.title = 'Test playlist';
5
6const media1 = new M3uMedia('http://my-stream-ulr.com/playlist.m3u8');
7media1.attributes = {'tvg-id': '5', 'tvg-language': 'EN', 'unknown': 'my custom attribute'};
8media1.duration = 500;
9media1.name = 'Test Channel';
10media1.group = 'Test Group';
11
12playlist.medias.push(media1);
13const m3uString = playlist.getM3uString();

you get

#EXTM3U
#PLAYLIST:Test playlist
#EXTINF:500 tvg-id="5" tvg-language="EN" unknown="my custom attribute",Test Channel
#EXTGRP:Test Group
http://my-stream-ulr.com/playlist.m3u8

🌐 Browser

You can also use this library in the browser without compiling using jsDelivr. Import script into HTML file, and you can access classes through the global m3uParserGenerator object.

1<script src="https://cdn.jsdelivr.net/npm/m3u-parser-generator@5.0.1/dist/m3u-parser-generator.iife.js"></script>
2<script>
3    const playlist = new m3uParserGenerator.M3uPlaylist();
4    const media1 = new m3uParserGenerator.M3uMedia('http://my-stream-ulr.com/playlist.m3u8');
5    playlist.medias.push(media1);
6    
7    const parser = new m3uParserGenerator.M3uParser();
8    const parsedPlaylist = parser.parse(m3uString);
9</script>

⚖️ License

MIT