SrtOutputSettings interface

onConnection?

( streamId: string, streamIndex: number, remoteHost: string) ⇒ void

(Optional) On connect callback, notifying that a new caller has connected (in listener mode) and providing the stream_id that was set on the socket

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

host

string

The IP address or hostname to listen on in listener mode, or to connect to in caller mode

inputBandwidth?

number

(Optional) Input bandwidth (SRTO_INPUTBW)

jitterBuffer?

JitterBufferConfig

(Optional) Jitter buffer configuration

maxBandwidth?

number

(Optional) Max bandwidth (SRTO_MAXBW)

maxQueueMs?

number

(Optional) Maximum duration to hold any stream in the case that one or more are running behind. In the case the late stream is delayed rather than having a large gap, this will result in discarded input frames.

mode

SrtMode

The mode to act in (see SrtMode)

onBind?

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

(Optional) Called when a listener-mode SRT output binds to the interface

overheadBandwidth?

number

(Optional) Overhead bandwidth (SRTO_OHEADBW)

passphrase?

string

(Optional) Passphrase for encryption

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 in listener mode, or to connect to in caller mode

In listener mode the port may be given as 0 to bind to an automatically assigned port, which can be retrieved in onBind.

receiveLatency?

number

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

streamId?

string

(Optional) Stream ID to set on the socket when acting in caller mode

writeThroughFile?

WriteThroughFile

(Optional) File to write through all data to (this will be read from in order to produce the final SRT stream, useful for compliance purposes) NB: This will rollover automatically, but no expiry will take place, it is assumed that infrastructure will take care of this