RistPeerTuning interface

The knobs that apply to any one RIST peer. Every one is optional; leaving it unset keeps librist’s own default rather than a second copy of it here. see: NorskInput.rist()

Signature:

export interface RistPeerTuning

Properties

Property Type Description

Property	Type	Description
bufferMs?	number	(Optional) The retransmission buffer, in milliseconds. This is the latency budget: it is also the cap on how far back a lost packet can still be recovered, so it has to exceed the round-trip time by enough for a retry.
cname?	string	(Optional) The cname this receiver reports in its RTCP.
congestionControl?	RistCongestionControlSetting	(Optional)
keepaliveIntervalMs?	number	(Optional) How often keepalives are sent.
keyRotation?	number	(Optional) How often the encryption key is rotated, in packets.
keySize?	128 \| 256	(Optional) AES key size. Unset with a secret set = librist’s default.
listener?	boolean	(Optional) Bind and wait for a sender (the default), rather than dialling the host out.
localInterface?	string	(Optional) The local interface to bind, or to join a multicast group on.
maxBitrateKbps?	number	(Optional) Cap on the retransmission bitrate, in kbps.
maxRetries?	number	(Optional)
minRetries?	number	(Optional) Bounds on how many times one packet is asked for again.
reorderBufferMs?	number	(Optional) How long to hold a packet waiting for an earlier one before giving up on the order, in milliseconds.
rttMaxMs?	number	(Optional)
rttMinMs?	number	(Optional) Bounds on the RTT estimate used to pace retransmission requests.
secret?	string	(Optional) Main-profile encryption passphrase. Unset = unencrypted.
sessionTimeoutMs?	number	(Optional) How long without traffic before the peer is declared timed out.
srpPassword?	string	(Optional)
srpUsername?	string	(Optional) Main-profile SRP, for a peer that DIALS OUT (`listener: false`): the credentials it proves. Listening peers check senders against RistInputSettings.srpUsers instead.
timingMode?	RistTimingModeSetting	(Optional)
virtDstPort?	number	(Optional) Main profile only: which virtual destination port of the GRE tunnel this peer carries. Unset = librist’s default (1968).
weight?	number	(Optional) Load-balancing weight across peers. 0 (the default) means this peer carries a copy of everything, which is how RistInputSettings.redundantPeers gets seamless redundancy.

bufferMs?

number

(Optional) The retransmission buffer, in milliseconds. This is the latency budget: it is also the cap on how far back a lost packet can still be recovered, so it has to exceed the round-trip time by enough for a retry.

cname?

string

(Optional) The cname this receiver reports in its RTCP.

congestionControl?

RistCongestionControlSetting

(Optional)

keepaliveIntervalMs?

number

(Optional) How often keepalives are sent.

keyRotation?

number

(Optional) How often the encryption key is rotated, in packets.

keySize?

128 | 256

(Optional) AES key size. Unset with a secret set = librist’s default.

listener?

boolean

(Optional) Bind and wait for a sender (the default), rather than dialling the host out.

localInterface?

string

(Optional) The local interface to bind, or to join a multicast group on.

maxBitrateKbps?

number

(Optional) Cap on the retransmission bitrate, in kbps.

maxRetries?

number

(Optional)

minRetries?

number

(Optional) Bounds on how many times one packet is asked for again.

reorderBufferMs?

number

(Optional) How long to hold a packet waiting for an earlier one before giving up on the order, in milliseconds.

rttMaxMs?

number

(Optional)

rttMinMs?

number

(Optional) Bounds on the RTT estimate used to pace retransmission requests.

secret?

string

(Optional) Main-profile encryption passphrase. Unset = unencrypted.

sessionTimeoutMs?

number

(Optional) How long without traffic before the peer is declared timed out.

srpPassword?

string

(Optional)

srpUsername?

string

(Optional) Main-profile SRP, for a peer that DIALS OUT (listener: false): the credentials it proves. Listening peers check senders against RistInputSettings.srpUsers instead.

timingMode?

RistTimingModeSetting

(Optional)

virtDstPort?

number

(Optional) Main profile only: which virtual destination port of the GRE tunnel this peer carries. Unset = librist’s default (1968).

weight?

number

(Optional) Load-balancing weight across peers. 0 (the default) means this peer carries a copy of everything, which is how RistInputSettings.redundantPeers gets seamless redundancy.