WebRTCBrowserSettings interface

Settings for a WebRTC browser session see: NorskDuplex.webRtcBrowser()

Signature:

export interface WebRTCBrowserSettings extends ProcessorNodeSettings<WebRTCBrowserNode>, StreamStatisticsMixin

Extends: ProcessorNodeSettings<WebRTCBrowserNode>, StreamStatisticsMixin

Properties

Property Type Description

Property	Type	Description
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.
jitterBuffer?	JitterBufferConfig	(Optional) Jitter buffer configuration
name	string
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

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.

jitterBuffer?

JitterBufferConfig

(Optional) Jitter buffer configuration

name

string

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