WhipInputSettings interface

onConnectionStatusChange?

(change: { status: WhipInputStatus; sessionId: string; }) ⇒ void

(Optional) Called when the connection status has changed for an individual client (eg the client is disconnected by timeout or request)

hostIps?

string[]

(Optional) List of IPs to advertise as your host address - useful e.g. when on a cloud server so that the public rather than private IP is used.

iceServers?

IceServerSettings[]

(Optional) ICE servers (STUN/TURN) the Norsk node uses to gather its own candidates. Must be reachable from the node itself - e.g. an internal/private TURN address inside the VPC or container network. Also advertised to the remote peer unless reportedIceServers overrides that.

name

string

onConnection?

(client: { sessionId: string; }) ⇒ WhipConnectionResult

(Optional)

onStats?

(stats: WebRtcStatsMessage) ⇒ void

(Optional) Callback giving stats from the WebRTC stack for an individual ingest session

reportedIceServers?

IceServerSettings[]

(Optional) ICE servers advertised to the remote peer (the browser / WHIP / WHEP client) for its own candidate gathering. Must be reachable from that client - e.g. the public TURN address. Defaults to iceServers. Set this when the node and the client reach the STUN/TURN server at different addresses (node via a private/internal address, client via the public one).

serverReflexiveIps?

string[]

(Optional) Similar to hostIps, but a list of server reflexive candidates so that ICE negotiations can be sped up

startupThreshold?

InputThresholdSettings

(Optional) When specified, drop the connect-time burst until the input is ticking at realtime

timeDomain?

TimeDomain

(Optional) Optional time-domain configuration. When set, the input is placed into a named coordinator and is timestamp-aligned with all other inputs sharing the same domain id within this Norsk instance. Omit for the default (uncoordinated) behaviour.