FileTsOutputSettings interface

The settings for an output Transport Stream written to file see: NorskOutput.fileTs()

Signature:

export interface FileTsOutputSettings extends SinkNodeSettings<FileTsOutputNode>, StreamStatisticsMixin

Extends: SinkNodeSettings<FileTsOutputNode>, StreamStatisticsMixin

Properties

Property Type Description

Property	Type	Description
avDelayMs?	number	(Optional) A/V delay in milliseconds - to allow inclusion of subtitles, metadata and other ancillary data. May be set to 0 if these are not present to reduce latency
fileName	string	The file to write - this will be truncated if it already exist
onSegmentStart?	(segment: FileTsSegmentStart) ⇒ void	(Optional) Called as each segment starts, before its bytes are written; see FileTsOutputSettings.segmentIndex
rollver?	RolloverSettings	(Optional) Rollover
segmentIndex?	{ segmentDurationMs: number; }	(Optional) Index the file as it is written: report where each segment starts, via FileTsOutputSettings.onSegmentStart. Absent (the default), no index is kept and nothing is reported. A segment starts on the first random access point at least `segmentDurationMs` (minimum 1000) after the previous start: a video keyframe, or on an audio-only stream an audio frame. Each starts with PAT/PMT, so the bytes from one start to the next decode on their own, e.g. as an HLS `EXT-X-BYTERANGE` segment. With an index, rollover waits for the next segment start, so every file opens on one.

avDelayMs?

number

(Optional) A/V delay in milliseconds - to allow inclusion of subtitles, metadata and other ancillary data. May be set to 0 if these are not present to reduce latency

fileName

string

The file to write - this will be truncated if it already exist

onSegmentStart?

(segment: FileTsSegmentStart) ⇒ void

(Optional) Called as each segment starts, before its bytes are written; see FileTsOutputSettings.segmentIndex

rollver?

RolloverSettings

(Optional) Rollover

segmentIndex?

{ segmentDurationMs: number; }

(Optional) Index the file as it is written: report where each segment starts, via FileTsOutputSettings.onSegmentStart. Absent (the default), no index is kept and nothing is reported.

A segment starts on the first random access point at least segmentDurationMs (minimum 1000) after the previous start: a video keyframe, or on an audio-only stream an audio frame. Each starts with PAT/PMT, so the bytes from one start to the next decode on their own, e.g. as an HLS EXT-X-BYTERANGE segment. With an index, rollover waits for the next segment start, so every file opens on one.