[FFmpeg-devel] [PATCH v2] avformat/libsrt: Document latency options unit

[pkv]

Hi

following comments I've removed the change of latency option type to 
AV_OPT_TYPE_DURATION and restricted the patch to documentation changes.

Regards

-------------- next part --------------
From 059d84df37b6aa6b53d9d8b92b77cd9099760441 Mon Sep 17 00:00:00 2001
From: pkv <pkv at obsproject.com>
Date: Tue, 7 Apr 2020 18:08:22 +0200
Subject: [PATCH] avformat/libsrt: Document latency options unit

Updated protocol doc for srt to specify the unit of various latency options.

The microsecond unit has caused confusion for both FFmpeg and obs-studio users
because latency is in milliseconds in libsrt API :
- https://github.com/Haivision/srt/issues/1223

- https://obsproject.com/mantis/view.php?id=1617
---
 doc/protocols.texi | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index e510019f2d..ebf9dec529 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -1286,8 +1286,8 @@ 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
-Timestamp-based Packet Delivery Delay.
+ at item latency=@var{microseconds}
+Timestamp-based Packet Delivery Delay in microseconds.
 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
@@ -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 at 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.
-- 
2.24.1.windows.2