SrtDedicatedPortOutputSettings interface

onPublishedNameFailed?

(info: { name: string; reason: string; }) ⇒ void

(Optional) Called when the SrtDedicatedPortOutputSettings.publishedName configured on this output was not published, so nothing using resolve will find it. Either the discovery directory refused the claim — most often because something else is already publishing that name — or this instance never made the claim, because no discovery service is configured for it or its advertise configuration cannot express the bound port. reason says which; the last two are plain misconfiguration and are the likeliest in practice.

This is not a failure of the output. It keeps streaming, and anything configured with an explicit address still reaches it; what is lost is only the name. Nothing retries: whether a name is worth waiting for depends on what the name is for, which only your code knows. To retry, publish again under a name you know to be free.

This callback is the durable record. The engine also raises a node notification, which surfaces in the visualiser and on the notification bus, but that is an event rather than a standing alert — it ages out after a few seconds. If you do not supply this callback the failure is logged to the console rather than passing silently.

acceptBonded?

boolean

(Optional) Listener mode only: accept bonded consumers — SRT connection bonding (see SrtBondingSettings). A bonded consumer dials this port over several links and is sent every packet on each (broadcast), or on its active link (backup), so it rides out a link failing. Every link is checked against this output’s streamid grants and passphrases like any other connection. Consumers that do not bond are unaffected.

host

string

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

listenerSockets?

number

(Optional) Listener mode only: how many sockets this output binds on its port, each with its own SRT receive and send threads; consumers are spread across them by the operating system. Useful when one output has many consumers. The port, stream IDs and passphrases are unchanged.

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

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

passphrase?

string

(Optional) Passphrase for encryption

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.

portMode?

"non-multiplexed"

(Optional) How this output gets a port. Omitted (or "non-multiplexed") means it binds or calls one of its own, which is what every SRT output did before multiplexing existed — so existing configurations need no change.

publishedName?

string

(Optional) Listener mode only. When set, once the socket is bound this output publishes its presence to the node-local norsk-discovery service under this logical name, so an SRT caller elsewhere can resolve it (see ) instead of being wired to a fixed address — useful when the port is auto-allocated (port: 0) or the host may move. The advertised address is derived from the instance’s advertise configuration and the bound port. Requires a discovery service to be configured for the instance.

requireGrants?

boolean

(Optional) Listener mode only: fail closed on the access grants (SrtOutputNode.addPassphrase()). By default an output with NO grants accepts every consumer, so removing the last grant reopens it to anyone. With requireGrants: true it refuses every consumer instead — reported to SrtOutputSettingsCommon.onConnectionRejected with reason "no_grants" — until the first grant is added, and again once the last one is removed. Default false. For a multiplexed output set it on the SrtMultiplexEgest instead.

streamId?

string

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