lavf: document request_probe properly

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

1 files changed, 4 insertions, 1 deletions

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index b635ae7cf3..166fdbb228 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -809,7 +809,10 @@ typedef struct AVStream {
     unsigned int index_entries_allocated_size;
 
     /**
-     * flag to indicate that probing is requested
+     * stream probing state
+     * -1   -> probing finished
+     *  0   -> no probing requested
+     * rest -> perform probing with request_probe being the minimum score to accept.
      * NOT PART OF PUBLIC API
      */
     int request_probe;