hlx-file-writer
A writable stream to save HLS playlists/segments as local files
Features
- Being used with other
hlx
objects, it provides a functionality to write every HLS related data (playlist and segments) to your local filesystem. - It determines the local path for each files based on the
uri
described in the HLS playlist. - The hostname contained in the
uri
will be ignored (e.g. "https://foo.bar/abc/def.m3u8" is translated into "{outputDir}/abc/def.m3u8") - If the
uri
is a file url, users can specify a root directory (inputDir
) from which the file should be read (e.g. "file://path/to/abc/def.m3u8", inputDir="/path/to", is translated into "{outputDir}/abc/def.m3u8")
Install
Usage
const createReadStream = ;const createUrlRewriter = ;const createWriteStream = ; // file-writerconst createTerminator = const src = ;const rewrite = ;const save = ;const dest = ; // Write all playlists/segments to your local filesystemsrc;
API
The features are built on top of the Node's transform streams.
createWriteStream([options])
Creates a new TransformStream
object.
params
Name | Type | Required | Default | Description |
---|---|---|---|---|
options | object | No | {} | See below |
options
Name | Type | Default | Description |
---|---|---|---|
inputDir | string | / | The root directory from which all the files are read (This option is only used in case of file urls) |
outputDir | string | process.CWD() | The root directory to which all the files are written |
storePlaylist | boolean | false | If true, the playlist files are also stored as local files |
return value
An instance of TransformStream
.