libavformat/oggdec.h: Document packet function return value.

Romain Beauxis committed 1 year ago

Commit 6d54af61 parent 0d7172a1 file · +6 −0Browse files

Unified · Split

libavformat/oggdec.h+6−0

@@ -38,6 +38,12 @@ struct ogg_codec { · 37 unmodified lines
38	38	* -1 if an error occurred or for unsupported stream
39	39	*/
40	40	int (header)(AVFormatContext , int);
	41	+ /**
	42	+ * Attempt to process a packet as a data packet
	43	+ * @return < 0 (AVERROR) code or -1 on error
	44	+ * == 0 if the packet was a regular data packet.
	45	+ * == 0 or 1 if the packet was a header from a chained bitstream.
	46	+ */
41	47	int (packet)(AVFormatContext , int);
42	48	/**
43	49	* Translate a granule into a timestamp.