[FFmpeg-devel] [PATCH v1 1/3] doc/protocols: clarify timeout and latency unit of measurement for SRT

[Limin Wang]

ping the patchset.

On Tue, Mar 31, 2020 at 10:08:06PM +0800, lance.lmwang at gmail.com wrote:
> From: Limin Wang <lance.lmwang at gmail.com>
> 
> Signed-off-by: Limin Wang <lance.lmwang at gmail.com>
> ---
>  doc/protocols.texi | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index e510019..7aa7585 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -1255,7 +1255,7 @@ options.
>  This protocol accepts the following options.
>  
>  @table @option
> - at item connect_timeout
> + at item connect_timeout=@var{milliseconds}
>  Connection timeout; SRT cannot connect for RTT > 1500 msec
>  (2 handshake exchanges) with the default connect timeout of
>  3 seconds. This option applies to the caller and rendezvous
> @@ -1286,7 +1286,7 @@ 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.
>  
> - at item latency
> + at item latency=@var{microseconds}
>  Timestamp-based Packet Delivery Delay.
>  Used to absorb bursts of missed packet retransmissions.
>  This flag sets both @option{rcvlatency} and @option{peerlatency}
> @@ -1297,7 +1297,7 @@ when side is sender and @option{rcvlatency}
>  when side is receiver, and the bidirectional stream
>  sending is not supported.
>  
> - at item listen_timeout
> + at item listen_timeout=@var{microseconds}
>  Set socket listen timeout.
>  
>  @item maxbw=@var{bytes/seconds}
> @@ -1377,7 +1377,7 @@ use a bigger maximum frame size, though not greater than
>  @item pkt_size=@var{bytes}
>  Alias for @samp{payload_size}.
>  
> - at item peerlatency
> + at item peerlatency=@var{microseconds}
>  The latency value (as described in @option{rcvlatency}) that is
>  set by the sender side as a minimum value for the receiver.
>  
> @@ -1389,7 +1389,7 @@ Not required on receiver (set to 0),
>  key size obtained from sender in HaiCrypt handshake.
>  Default value is 0.
>  
> - at item rcvlatency
> + at item rcvlatency=@var{microseconds}
>  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.
> @@ -1407,7 +1407,7 @@ Set UDP receive buffer size, expressed in bytes.
>  @item send_buffer_size=@var{bytes}
>  Set UDP send buffer size, expressed in bytes.
>  
> - at item timeout
> + at item timeout=@var{microseconds}
>  Set raise error timeouts for read, write and connect operations. Note that the
>  SRT library has internal timeouts which can be controlled separately, the
>  value set here is only a cap on those.
> -- 
> 2.9.5
> 

-- 
Thanks,
Limin Wang