diff options
author | James Almer <jamrial@gmail.com> | 2018-09-02 19:11:45 -0300 |
---|---|---|
committer | James Almer <jamrial@gmail.com> | 2018-09-02 19:11:45 -0300 |
commit | de33b3e457a656230fc6d544a1889218d77a5b3c (patch) | |
tree | 00c27842a2b92e62c0f7beae48506814c5376b57 /doc | |
parent | b1b0e532583e26f18ba27f3cc8775dbd62f3bc2b (diff) | |
parent | a507af97eef468238d545ff954a39d7432832e54 (diff) |
Merge commit 'a507af97eef468238d545ff954a39d7432832e54'
* commit 'a507af97eef468238d545ff954a39d7432832e54':
avformat/libsrt: add latency options and deprecate tspbdelay
Merged-by: James Almer <jamrial@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/protocols.texi | 31 |
1 files changed, 27 insertions, 4 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi index 6322581c86..fad6c44c24 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -1210,6 +1210,17 @@ IP Type of Service. Applies to sender only. Default value is 0xB8. @item ipttl=@var{ttl} IP Time To Live. Applies to sender only. Default value is 64. +@item latency +Timestamp-based Packet Delivery Delay. +Used to absorb bursts of missed packet retransmissions. +This flag sets both @option{rcvlatency} and @option{peerlatency} +to the same value. Note that prior to version 1.3.0 +this is the only flag to set the latency, however +this is effectively equivalent to setting @option{peerlatency}, +when side is sender and @option{rcvlatency} +when side is receiver, and the bidirectional stream +sending is not supported. + @item listen_timeout Set socket listen timeout. @@ -1270,6 +1281,10 @@ use a bigger maximum frame size, though not greater than @item pkt_size=@var{bytes} Alias for @samp{payload_size}. +@item peerlatency +The latency value (as described in @option{rcvlatency}) that is +set by the sender side as a minimum value for the receiver. + @item pbkeylen=@var{bytes} Sender encryption key length, in bytes. Only can be set to 0, 16, 24 and 32. @@ -1278,6 +1293,18 @@ Not required on receiver (set to 0), key size obtained from sender in HaiCrypt handshake. Default value is 0. +@item rcvlatency +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, unexpectedly extended RTT +time, and the time needed to retransmit the lost UDP +packet. The effective latency value will be the maximum +of this options' value and the value of @option{peerlatency} +set by the peer side. Before version 1.3.0 this option +is only available as @option{latency}. + @item recv_buffer_size=@var{bytes} Set receive buffer size, expressed in bytes. @@ -1302,10 +1329,6 @@ have no chance of being delivered in time. It was automatically enabled in the sender if the receiver supports it. -@item tsbpddelay -Timestamp-based Packet Delivery Delay. -Used to absorb burst of missed packet retransmission. - @end table For more information see: @url{https://github.com/Haivision/srt}. |