SrtMultiplexEgestSettings interface

onBind?

(info: { port: number; }) ⇒ void

(Optional) Called when the multiplex binds its port. Also the way to learn the port when 0 was requested — though SrtMultiplexEgest.port carries the same number once the multiplex has started.

onConnectionRejected?

(rejection: { streamId: string; route: string; user?: string; remoteHost: string; reason: string; }) ⇒ void

(Optional) A consumer refused at the handshake because no output on this multiplex holds a grant for its (route, user) — either the route names no output, or that output has not granted that user. Grants live on the outputs, so this is where a misdirected consumer shows up rather than on the output it was aiming at.

acceptBonded?

boolean

(Optional) Accept bonded consumers on the shared port — SRT connection bonding (see SrtBondingSettings). Each link is routed to its output and checked against that output’s grants like any other connection.

host

string

The IP address or hostname to listen on

id

string

Names this multiplex to the outputs that share it. Unique within the instance: a second multiplex claiming the same id fails to start.

inputBandwidth?

number

(Optional) Input bandwidth (SRTO_INPUTBW)

listenerSockets?

number

(Optional) How many sockets the multiplex binds on its port, each with its own SRT receive and send threads; consumers are spread across them by the operating system. Every output sharing the multiplex sends through it, so with one socket all of their consumers' traffic goes through one send thread. Routes, grants and the port are unchanged.

Linux only (ignored elsewhere). 1—​32; unset or 1 means one socket.

maxBandwidth?

number

(Optional) Max bandwidth (SRTO_MAXBW)

onClose?

(() ⇒ Promise<void>) | (() ⇒ void)

(Optional)

onError?

(error: Error) ⇒ void

(Optional)

overheadBandwidth?

number

(Optional) Overhead bandwidth (SRTO_OHEADBW)

peerLatency?

number

(Optional) The latency value provided by the sender side as a minimum value for the receiver (SRTO_PEERLATENCY)

port

number

The port to listen on, shared by every output that uses this multiplex. May be 0 to bind an automatically assigned port, which is then reported to onBind and settled by the time this call resolves.

receiveLatency?

number

(Optional) The latency value in the receiving direction of the socket (SRTO_RCVLATENCY)

tlpktdrop?

boolean

(Optional) Whether to enable the too-late-packet-drop mechanism (SRTO_TLPKTDROP) - default true.