[docs] Added buffer configuration guide #1951
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maxsharabayko
added
Type: Enhancement
maxsharabayko
requested review from
rndi,
stevomatthews,
mbakholdina and
cmollahan
mbakholdina
reviewed
Apr 16, 2021
maxsharabayko
commented
Apr 23, 2021
Co-authored-by: stevomatthews <smatthews@haivision.com>
mbakholdina
reviewed
Apr 23, 2021
mbakholdina
reviewed
Apr 23, 2021
mbakholdina
reviewed
Apr 23, 2021
docs/API/configure-buffers.md
Outdated
| - **300 Mbits** of payload in the default file transfer configuration with an SRT payload size of **1456 bytes**. | ||
|
|
||
| The default receiver buffer size is 8192 packets. It is approximately: | ||
| - **86 Mbits** of payload with the effective SRT payload size of **1316 bytes**. |
There was a problem hiding this comment.
What's about 1456 bytes?
mbakholdina
reviewed
Apr 23, 2021
mbakholdina
reviewed
Apr 23, 2021
mbakholdina
reviewed
Apr 23, 2021
docs/API/configure-buffers.md
Outdated
|
|
||
| The minimum size of the receiver buffer in packets can be calculated as follows: | ||
|
|
||
| `pktsRBufSize = bps / 8 × (RTTsec + latency_sec) / bytePayloadSize` |
There was a problem hiding this comment.
Can we consider better variables' names here?
pktsRBufSize -> pktsRecvBufSize
bps -> bpsRate
RTTsec -> secRTT
secLatency
bytesPayloadSize
mbakholdina
reviewed
Apr 23, 2021
docs/API/configure-buffers.md
Outdated
|
|
||
| - `bps` is the payload bitrate of the stream in bits per second; | ||
| - `RTTsec` is the RTT of the network connection in seconds; | ||
|
|
mbakholdina
reviewed
Apr 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added configure-buffers.md document.
Closes #703.