hls-parser

Provides synchronous functions to read/write HLS playlists

Install

Usage

const HLS = require('hls-parser'); // For node
// For browsers, just use dist/hls-parser.min.js defined as a UMD module.

// Parse the playlist
const playlist = HLS.parse(textData);
// You can access the playlist as a JS object
if (playlist.isMasterPlaylist) {
  // Master playlist
} else {
  // Media playlist
}
// Create a new playlist
const {MediaPlaylist, Segment} = HLS.types;
const obj = new MediaPlaylist({
  targetDuration: 9,
  playlistType: 'VOD',
  segments: [
    new Segment({
      uri: 'low/1.m3u8'
      duration: 9,
      mediaSequenceNumber: 0,
      discontinuitySequence: 0
    })
  ]
}));
// Convert the object into a text
const text = HLS.stringify(obj);

API

HLS.parse(str)

Converts a text playlist into a structured JS object

params

return value

An instance of either MasterPlaylist or MediaPlaylist (See Data format below.)

HLS.stringify(obj)

Converts a JS object into a plain text playlist

params

return value

A text data that conforms to the HLS playlist spec

HLS.types

An object that holds all the classes described below.

Data format

This section describes the structure of the object returned by parse() method.

Data

Playlist (extends Data)

MasterPlaylist (extends Playlist)

Variant

Rendition

SessionData

MediaPlaylist (extends Playlist)

Segment (extends Data)

Key

MediaInitializationSection

DateRange