WhepOutputSettings interface

The settings for a WebRTC WHEP Output see NorskOutput.whep()

Signature:

export interface WhepOutputSettings extends SinkNodeSettings<WhepOutputNode>, StreamStatisticsMixin

Extends: SinkNodeSettings<WhepOutputNode>, StreamStatisticsMixin

Properties

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) List of ice servers to use as part of session negotiation
jitterBuffer?	JitterBufferConfig	(Optional) Jitter buffer configuration
maxQueueMs?	number	(Optional) Maximum duration to hold any media stream in the case that one or more are running behind. In the case the late stream is delayed rather than having a large gap, this will result in discarded input frames. Should not be required in general, could be useful to ensure low latency when there are gaps in input (eg few seconds of decode error)
name	string
onPublishStart?	() ⇒ void	(Optional) Callback to signify the WHEP output is publishing media and ready for client connection
onPublishStop?	() ⇒ void	(Optional) Callback to signify the WHEP output has stopped publishing media and will reject client connections i.e. A WHEP output which has previously been usable, and has now had its source turned off, but may become usable in the future if a new source appears.
reportedIceServers?	IceServerSettings[]	(Optional) Internal addresses for the ice servers (defaults to iceServers)
serverReflexiveIps?	string[]	(Optional) Similar to hostIps, but a list of server reflexive candidates so that ICE negotiations can be sped up

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) List of ice servers to use as part of session negotiation

jitterBuffer?

JitterBufferConfig

(Optional) Jitter buffer configuration

maxQueueMs?

number

(Optional) Maximum duration to hold any media stream in the case that one or more are running behind. In the case the late stream is delayed rather than having a large gap, this will result in discarded input frames. Should not be required in general, could be useful to ensure low latency when there are gaps in input (eg few seconds of decode error)

name

string

onPublishStart?

() ⇒ void

(Optional) Callback to signify the WHEP output is publishing media and ready for client connection

onPublishStop?

() ⇒ void

(Optional) Callback to signify the WHEP output has stopped publishing media and will reject client connections

i.e. A WHEP output which has previously been usable, and has now had its source turned off, but may become usable in the future if a new source appears.

reportedIceServers?

IceServerSettings[]

(Optional) Internal addresses for the ice servers (defaults to iceServers)

serverReflexiveIps?

string[]

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