Mercurial > libavformat.hg
diff oggdec.h @ 4764:c6abeafbec30 libavformat
Document ogg_codec's header function
author | conrad |
---|---|
date | Sat, 21 Mar 2009 08:03:30 +0000 |
parents | dcdf236c9909 |
children | 42098ccb51ab |
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);