From a8540daba9469a13d03dbae5e2883c894aeeab15 Mon Sep 17 00:00:00 2001 From: Maxim Sharabayko Date: Wed, 28 Aug 2019 15:27:54 +0200 Subject: [PATCH] [docs] A note about default 120 ms latency --- docs/API.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 15f011929..d6531c5d1 100644 --- a/docs/API.md +++ b/docs/API.md @@ -549,6 +549,7 @@ The allowed range for this value is between 1 and half of the current value of `SRTO_KMREFRESHRATE`. The minimum value should never be less than the flight window (i.e. the number of packets that have already left the sender but have not yet arrived at the receiver). + --- | OptName | Since | Binding | Type | Units | Default | Range | @@ -827,8 +828,10 @@ value. For desired result, configure MSS first.*** | OptName | Since | Binding | Type | Units | Default | Range | | --------------------- | ----- | ------- | --------- | ------ | -------- | ------------- | -| `SRTO_RCVLATENCY` | 1.3.0 | pre | `int32_t` | msec | 0 | positive only | +| `SRTO_RCVLATENCY` | 1.3.0 | pre | `int32_t` | msec | 120 | positive only | +- **NB:** The default [live mode](#transmission-method-live) settings set `SRTO_RCVLATENCY` to 120 ms! +The [buffer mode](#transmission-method-buffer) settings set `SRTO_RCVLATENCY` to 0. - The time that should elapse since the moment when the packet was sent and the moment when it's delivered to the receiver application in the receiving function. This time should be a buffer time large enough to cover the time spent for sending,