SrtInputSettings interface

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

Signature:

export interface SrtInputSettings extends RemoteInputSettings<SrtInputNode>, StreamStatisticsMixin

Extends: RemoteInputSettings<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

inputBandwidth?

number

(Optional) Input bandwidth (SRTO_INPUTBW)

maxBandwidth?

number

(Optional) Max bandwidth (SRTO_MAXBW)

mode

SrtMode

The mode to act in (caller or listener)

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)

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