path: root/DOCS
diff options
authorwm4 <wm4@nowhere>2017-11-10 16:43:09 +0100
committerwm4 <wm4@nowhere>2017-11-10 16:43:18 +0100
commit8e50dc1b4dda5d15ddf0b1cc28b907356b956512 (patch)
tree1a4b752cebef99ef578cf38e585dedb651b676dd /DOCS
parent1b0dc7d169cc7ef3ef20727781b1e8fee5ca159f (diff)
demux: export demuxer cache sizes in bytes
Plus sort of document them, together with the already existing undocumented fields. (This is mostly for debugging, so use is discouraged.)
Diffstat (limited to 'DOCS')
1 files changed, 21 insertions, 0 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 2b3e2a3795..75cb9526c6 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1285,6 +1285,27 @@ Property list
+ Other fields (might be changed or removed in the future):
+ ``eof``
+ True if the reader thread has hit the end of the file.
+ ``underrun``
+ True if the reader thread could not satisfy a decoder's request for a
+ new packet.
+ ``idle``
+ True if the thread is currently not reading.
+ ``total-bytes``
+ Sum of packet bytes (plus some overhead estimation) of the entire packet
+ queue, including cached seekable ranges.
+ ``fw-bytes``
+ Sum of packet bytes (plus some overhead estimation) of the readahead
+ packet queue (packets between current decoder reader positions and
+ demuxer position).
Returns ``yes`` if the stream demuxed via the main demuxer is most likely
played via network. What constitutes "network" is not always clear, might