Mercurial > libavformat.hg

changeset 4764:c6abeafbec30 libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document ogg_codec's header function
author conrad
date Sat, 21 Mar 2009 08:03:30 +0000
parents e69e94c9d3e2
children 6ab95f681099
files oggdec.h
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/oggdec.h	Sat Mar 21 07:36:25 2009 +0000
+++ b/oggdec.h	Sat Mar 21 08:03:30 2009 +0000
@@ -31,6 +31,12 @@
     const int8_t *magic;
     uint8_t magicsize;
     const int8_t *name;
+    /**
+     * Attempt to process a packet as a header
+     * @return 1 if the packet was a valid header,
+     *         0 if the packet was not a header (was a data packet)
+     *         -1 if an error occurred or for unsupported stream
+     */
     int (*header)(AVFormatContext *, int);
     int (*packet)(AVFormatContext *, int);
     uint64_t (*gptopts)(AVFormatContext *, int, uint64_t);