AVSEEK_SIZE doxy

Originally committed as revision 7397 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 27fb241..3f733f0 100644 (file)
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -69,6 +69,11 @@ void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
 /* not implemented */
 int url_poll(URLPollEntry *poll_table, int n, int timeout);
 
+/**
+ * passing this as the "whence" parameter to a seek function causes it to
+ * return the filesize without seeking anywhere, supporting this is optional
+ * if its not supprted then the seek function will return <0
+ */
 #define AVSEEK_SIZE 0x10000
 
 typedef struct URLProtocol {