HlsPushDestinationSettings interface

Configuration for pushing a segmented media stream directly to a generic http server

Signature:

export interface HlsPushDestinationSettings

Properties

Property Type Description

defaultSegmentCount?

number

(Optional) In the absence of a HLS_SKIP query parameter, how many segments should be served in a playlist this effectively controls how far back in time a player can seek from first load (as long as the data exists)

holdBackSeconds?

number

(Optional) Server control directive, informs the client how far back in the stream (in seconds) it should attempt to play this should take into account the end to end latency from source capture, to the segment and playlist being published

host

string

The hostname of the web server being pushed to. This will be used to re-resolve the IP address on failures

id

DestinationId

A unique identifier for this destination

This can be used for supplying updates to configuration to this destination specifically see: UpdateCredentials

partHoldBackSeconds?

number

(Optional) Server control directive, informs the client how far back in the stream (in seconds) it should attempt to play when using the lower latency parts this should take into account the end to end latency from source capture, to the part and playlist being published

pathPrefix

string

the path under which segments and playlists will be pushed to

port

number

the port of the web server being pushed to.

retentionPeriodSeconds

number

Informs the playlist generation how long segments will be retained for on the remote server in order to generate an accurate playlist

sessionId?

string

(Optional) Optionally supply a string that will be inserted into the path structure for segments published in this stream

This is useful for stream restarts or republishing when duplicate segment IDs would be generated causing problems with cacheing directives

supportsGzip?

boolean

(Optional) Whether the server supports gzip request compression for PUT/POST requests

tlsTransport?

boolean

(Optional) Whether to use TLS or plain TCP transport, by default TLS used if port is 443

type

"generic"