m3u8stream

  • Version 0.8.4
  • Published
  • 49.5 kB
  • 2 dependencies
  • MIT license

Install

npm i m3u8stream
yarn add m3u8stream
pnpm add m3u8stream

Overview

Reads segments from a m3u8 or dash playlist into a consumable stream.

Index

Variables

variable m3u8stream

let m3u8stream: m3u8stream.m3u8streamFunc;

    Interfaces

    interface m3u8streamFunc

    interface m3u8streamFunc {}

      method parseTimestamp

      parseTimestamp: (time: number | string) => number;

        call signature

        (playlistURL: string, options?: m3u8stream.Options): Stream;

          interface Options

          interface Options {}

            property begin

            begin?: number | string;

              property chunkReadahead

              chunkReadahead?: number;

                property highWaterMark

                highWaterMark?: number;

                  property id

                  id?: string;

                    property liveBuffer

                    liveBuffer?: number;

                      property parser

                      parser?: 'm3u8' | 'dash-mpd';

                        property requestOptions

                        requestOptions?: miniget.Options;

                          interface Progress

                          interface Progress {}

                            property duration

                            duration: number;

                              property num

                              num: number;

                                property size

                                size: number;

                                  property url

                                  url: string;

                                    interface Stream

                                    interface Stream extends PassThrough {}

                                      property end

                                      end: () => void;

                                        method on

                                        on: {
                                        (
                                        event: 'progress',
                                        progress: Progress,
                                        totalSegments: number,
                                        downloadedBytes: number
                                        ): this;
                                        (event: string | symbol, listener: (...args: any) => void): this;
                                        };

                                          Package Files (1)

                                          Dependencies (2)

                                          Dev Dependencies (13)

                                          Peer Dependencies (0)

                                          No peer dependencies.

                                          Badge

                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/m3u8stream.

                                          • Markdown
                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/m3u8stream)
                                          • HTML
                                            <a href="https://www.jsdocs.io/package/m3u8stream"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>