SrtInputSettings interface

Settings for an SRT Input node see: NorskInput.srt()

Signature:

export interface SrtInputSettings extends InputSettings<SrtInputNode>, StreamStatisticsMixin

Extends: InputSettings<SrtInputNode>, StreamStatisticsMixin

Events

Property Type Description

onConnection?

( streamId: string, index: number, remoteHost: string) ⇒ SrtConnectionResult

(Optional) On connect callback, notifying that a new caller has connected (in listener mode) and set the source name accordingly

onConnectionStatusChange?

( status: SrtInputStatus, sourceName: string | undefined) ⇒ void

(Optional) Called when the connection status has changed (e.g. when the SRT socket is closed)

Properties

Property Type Description

host

string

The IP or hostname of the remote server

inputBandwidth?

number

(Optional) Input bandwidth (SRTO_INPUTBW)

maxBandwidth?

number

(Optional) Max bandwidth (SRTO_MAXBW)

mode

SrtMode

The mode to act in (caller or listener)

onBind?

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

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

overheadBandwidth?

number

(Optional) Overhead bandwidth (SRTO_OHEADBW)

passphrase?

string

(Optional) Passphrase for encryption

peerIdleTimeoutMs?

number

(Optional) Idle timeout after which to disconnect if no data received. If unspecified a default timeout is used

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