WhipInputSettings interface

Signature:

export interface WhipInputSettings extends SourceNodeSettings<WhipInputNode>, StreamStatisticsMixin

Extends: SourceNodeSettings<WhipInputNode>, StreamStatisticsMixin

Events

Property Type Description

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)

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

name

string

onConnection?

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

(Optional)

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