Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

hlx-lib

Package Overview
Dependencies
Maintainers
1
Versions
29
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hlx-lib

A library for processing HLS streams

  • 0.0.20
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Build Status Coverage Status Dependency Status Development Dependency Status Known Vulnerabilities XO code style

hlx-lib

A library for processing HLS streams in Node.js

Features

Install

NPM

Usage

Example 1 - Default source / destination

const hlx = require('hlx'); // hlx-lib can be transparently referenced via hlx module
const {createDecryptor} = require('hlx-decryptor');
const decryptor = createDecryptor('AES-128');

// Store all decrypted files in /var/www/media/
hlx.src('https://foo.bar/sample.m3u8')
.pipe(decryptor)
.pipe(hlx.dest('/var/www/media/'));

Example 2 - Custom source

const hlx = require('hlx');
const {createReadStream} = require('hlx-src-webdav-pull');
const reader = createReadStream({
  url: 'http://foo.bar/webdav',
  user: {WebDAV user},
  pass: {WebDAV password}
});

// Store all decrypted files in /var/www/media/
hlx.src(reader)
.pipe(decryptor)
.pipe(hlx.dest('/var/www/media/'));

Example 3 - Custom destination

const hlx = require('hlx');
const {createReadStream} = require('hlx-dest-http-server');
const writer = createWriteStream({
  port: 8080,
  prefix: 'media',
  outputDir: '/var/www/media/'
});

// Host the stream at http://localhost:8080/media/sample.m3u8
hlx.src('https://foo.bar/sample.m3u8')
.pipe(decryptor)
.pipe(hlx.dest(writer));

API

src(location)

Creates a new stream.Readable object.

params
NameTypeRequiredDefaultDescription
locationstring or stream.ReadableYesN/AIt should be either of a local file path, a url of the playlist, or a custom source object.
return value

An instance of stream.Readable. When the location is a local file path or a url, the hlx-file-reader stream will be created. Otherwise, the passed readable stream will be returned back.

dest(location[, options])

Creates a new stream.Writable object.

params
NameTypeRequiredDefaultDescription
locationstring or stream.WritableNonullIt should be either of a local file path or a custom destination object.
optionsobjectNo{}See below
options
NameTypeDefaultDescription
inputDirstring/The root directory from which all the files are read (This option is only used in case of file urls)
return value

When the location is a local file path, the hlx-file-writer stream will be created. Otherwise, the passed writable stream will be returned back.

Keywords

FAQs

Package last updated on 10 Sep 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc