From 99862bd45780ee89f1fff20281b0d2678a8198f6 Mon Sep 17 00:00:00 2001 From: Maxim Sharabayko Date: Fri, 19 Feb 2021 10:57:15 +0100 Subject: [PATCH] [docs] Added SRTO_MININPUTBW to the docs --- docs/APISocketOptions.md | 23 ++++++++++++++++++++--- docs/srt-live-transmit.md | 1 + 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/APISocketOptions.md b/docs/APISocketOptions.md index aa34f4fb4..780b92228 100644 --- a/docs/APISocketOptions.md +++ b/docs/APISocketOptions.md @@ -211,6 +211,7 @@ The following table lists SRT socket options in alphabetical order. Option detai | [`SRTO_GROUPSTABTIMEO`](#SRTO_GROUPSTABTIMEO) | 1.5.0 | pre | `int32_t` | ms | 80 | 10-... | W | GSD+ | | [`SRTO_GROUPTYPE`](#SRTO_GROUPTYPE) | 1.5.0 | | `int32_t` | enum | | | R | S | | [`SRTO_INPUTBW`](#SRTO_INPUTBW) | 1.0.5 | post | `int64_t` | B/s | 0 | 0.. | RW | GSD | +| [`SRTO_MININPUTBW`](#SRTO_MININPUTBW) | 1.4.3 | post | `int64_t` | B/s | 0 | 0.. | RW | GSD | | [`SRTO_IPTOS`](#SRTO_IPTOS) | 1.0.5 | pre-bind | `int32_t` | | (system) | 0..255 | RW | GSD | | [`SRTO_IPTTL`](#SRTO_IPTTL) | 1.0.5 | pre-bind | `int32_t` | hops | (system) | 1..255 | RW | GSD | | [`SRTO_IPV6ONLY`](#SRTO_IPV6ONLY) | 1.4.0 | pre-bind | `int32_t` | | (system) | -1..1 | RW | GSD | @@ -501,12 +502,13 @@ context than inside the listener callback handler, the value is undefined. | ---------------- | ----- | -------- | ---------- | ------ | -------- | ------ | --- | ------ | | `SRTO_INPUTBW` | 1.0.5 | post | `int64_t` | B/s | 0 | 0.. | RW | GSD | -This option is effective only if `SRTO_MAXBW` is set to 0 (relative). It -controls the maximum bandwidth together with `SRTO_OHEADBW` option according +This option is effective only if [`SRTO_MAXBW`](#SRTO_MAXBW) is set to 0 (relative). It +controls the maximum bandwidth together with [`SRTO_OHEADBW`](#SRTO_OHEADBW) option according to the formula: `MAXBW = INPUTBW * (100 + OHEADBW) / 100`. When this option is set to 0 (automatic) then the real INPUTBW value will be estimated from the rate of the input (cases when the application calls the `srt_send*` -function) during transmission. +function) during transmission. The minimum allowed estimate value is restricted +by [`SRTO_MININPUTBW`](#SRTO_MININPUTBW), meaning `INPUTBW = MAX(INPUTBW_ESTIMATE; MININPUTBW)`. *Recommended: set this option to the anticipated bitrate of your live stream and keep the default 25% value for `SRTO_OHEADBW`*. @@ -515,6 +517,21 @@ and keep the default 25% value for `SRTO_OHEADBW`*. --- +#### SRTO_MININPUTBW + +| OptName | Since | Restrict | Type | Units | Default | Range | Dir | Entity | +| ----------------- | ----- | -------- | ---------- | ------ | -------- | ------ | --- | ------ | +| `SRTO_MININPUTBW` | 1.4.3 | post | `int64_t` | B/s | 0 | 0.. | RW | GSD | + +This option is effective only if both `SRTO_MAXBW` and `SRTO_INPUTBW` are set to 0. +It controls the minimum allowed value of the input butrate estimate. + +See [`SRTO_INPUTBW`](#SRTO_INPUTBW). + +[Return to list](#list-of-options) + +--- + #### SRTO_IPTOS | OptName | Since | Restrict | Type | Units | Default | Range | Dir | Entity | diff --git a/docs/srt-live-transmit.md b/docs/srt-live-transmit.md index 0a2dfb02d..a124c631c 100644 --- a/docs/srt-live-transmit.md +++ b/docs/srt-live-transmit.md @@ -307,6 +307,7 @@ All other parameters are SRT socket options. The following have the following va | `linger` | 0.. | `SRTO_LINGER` | Link linger value | | `lossmaxttl` | 0.. | `SRTO_LOSSMAXTTL` | Packet reorder tolerance. | | `maxbw` | 0.. | `SRTO_MAXBW` | Bandwidth limit in bytes | +| `mininputbw` | 0.. | `SRTO_MININPUTBW` | Minimum allowed estimate of `SRTO_INPUTBW` | | `messageapi` | `bool` | `SRTO_MESSAGEAPI` | Enable SRT message mode. | | `minversion` | maj.min.rev | `SRTO_MINVERSION` | Minimum SRT library version of a peer. | | `mss` | 76.. | `SRTO_MSS` | MTU size |