]> git.sesse.net Git - ffmpeg/blobdiff - doc/protocols.texi
avfilter: add nvidia NPP based transpose filter
[ffmpeg] / doc / protocols.texi
index 4c5e972a049d861d8ce20551ddebea7c77beac11..fad6c44c24558df85e4c24673d3bcee5f40469db 100644 (file)
@@ -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 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.
 
 @item listen_timeout
 Set socket listen timeout.
 
@@ -1255,6 +1266,25 @@ only if @option{pbkeylen} is non-zero. It is used on
 the receiver only if the received data is encrypted.
 The configured passphrase cannot be recovered (write-only).
 
 the receiver only if the received data is encrypted.
 The configured passphrase cannot be recovered (write-only).
 
+@item payload_size=@var{bytes}
+Sets the maximum declared size of a packet transferred
+during the single call to the sending function in Live
+mode. Use 0 if this value isn't used (which is default in
+file mode).
+Default is -1 (automatic), which typically means MPEG-TS;
+if you are going to use SRT
+to send any different kind of payload, such as, for example,
+wrapping a live stream in very small frames, then you can
+use a bigger maximum frame size, though not greater than
+1456 bytes.
+
+@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.
 @item pbkeylen=@var{bytes}
 Sender encryption key length, in bytes.
 Only can be set to 0, 16, 24 and 32.
@@ -1263,11 +1293,17 @@ Not required on receiver (set to 0),
 key size obtained from sender in HaiCrypt handshake.
 Default value is 0.
 
 key size obtained from sender in HaiCrypt handshake.
 Default value is 0.
 
-@item pkt_size=@var{bytes}
-Set maximum SRT payload size, expressed in bytes. Default is -1 (automatic),
-which typically means 1316 as that is the libsrt default for live mode. Libsrt
-can also support payload sizes up to 1456 bytes. (MTU(1500) - UDP.hdr(28) -
-SRT.hdr(16))
+@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.
 
 @item recv_buffer_size=@var{bytes}
 Set receive buffer size, expressed in bytes.
@@ -1293,10 +1329,6 @@ have no chance of being delivered in time. It was
 automatically enabled in the sender if the receiver
 supports it.
 
 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}.
 @end table
 
 For more information see: @url{https://github.com/Haivision/srt}.