Document url_seek().

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

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 8145f92..fec65fd 100644 (file)
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -113,6 +113,21 @@ int url_read(URLContext *h, unsigned char *buf, int size);
  */
 int url_read_complete(URLContext *h, unsigned char *buf, int size);
 int url_write(URLContext *h, unsigned char *buf, int size);
+
+/**
+ * Changes the position that will be used by the next read/write
+ * operation on the resource accessed by h.
+ *
+ * @param pos specifies the new position to set
+ * @param whence specifies how pos should be interpreted, it must be
+ * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
+ * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
+ * (return the filesize of the requested resource, pos is ignored).
+ * @return a negative value corresponding to an AVERROR code in case
+ * of failure, or the resulting file position, measured in bytes from
+ * the beginning of the file. You can use this feature together with
+ * SEEK_CUR to read the current file position.
+ */
 int64_t url_seek(URLContext *h, int64_t pos, int whence);
 
 /**