Drop Radio Docs
    Preparing search index...

    Interface HLSStreamOptions

    Options for configuring HLS streaming.

    HLS_STREAM_DEFAULTS for default options.

    interface HLSStreamOptions {
        concat?: boolean;
        formats?: HLSStreamFormat[];
        loopCount?: number;
        masterPlaylistName?: string;
        playlistName?: string;
        seekTime?: string;
        segmentCount?: number;
        segmentDuration?: number;
        segmentFileNameSuffix?: string;
    }
    Index

    Properties

    concat? formats? loopCount? masterPlaylistName? playlistName? seekTime? segmentCount? segmentDuration? segmentFileNameSuffix?

    Properties

    concat?: boolean

    An optional flag to indicate whether to expect the input to be a plain text file with a list of files to concatenate.

    formats?: HLSStreamFormat[]

    An optional list of formats to be used for the HLS stream. Each format corresponds to an individual output stream with the specified name, bitrate, and sample rate.

    HLSStreamFormat

    loopCount?: number

    An optional number of times to loop the input. If set to -1, the input will be looped indefinitely. If set to 0, the input will be played once, and if set to 1, it will be played twice, etc.

    masterPlaylistName?: string

    An optional name for the playlist file. This file will be at the root of the output directory, and have the .m3u8 file extension, so there should be no path prefix or file extension included in this value.

    playlistName?: string

    An optional name for the playlist files generated for each variable-quality stream. These files will be in a sub-directory named after the format they belong to, and they will have the .m3u8 file extension, so there should be no path prefix or file extension added.

    seekTime?: string

    An optional start time of the stream relative to the start of the input file, in fractional seconds (e.g., '10', or '5.345'). Note that progress events emitted by the resulting Observable will have total time properties that are relative to this seek time.

    segmentCount?: number

    An optional number of segments tracked by the generated playlist files. Older segment files (over a threshold) will be automatically removed. This times the segmentDuration is the "buffer size" of the HLS stream.

    segmentDuration?: number

    An optional duration for each stream segment, in seconds. This times the segmentCount is the "buffer size" of the HLS stream

    segmentFileNameSuffix?: string

    An optional suffix for generated segment file names. These files will be in a sub-directory named after the format they belong to, they will be prefixed by the current date and time in YYYYMMDD_SSSssssss format, and they will have the .ts file extension, so there should be no file extension included in this value.

    Settings

    Member Visibility

    On This Page

    Properties