summaryrefslogtreecommitdiff
path: root/libavformat/rm.h
diff options
context:
space:
mode:
Diffstat (limited to 'libavformat/rm.h')
-rw-r--r--libavformat/rm.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/libavformat/rm.h b/libavformat/rm.h
index 6e5d2c5f7e..53dd019cde 100644
--- a/libavformat/rm.h
+++ b/libavformat/rm.h
@@ -64,9 +64,9 @@ int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
* @param flags pointer to an integer containing the packet flags, may be
updated
* @param ts pointer to timestamp, may be updated
- * @return >=0 on success (where >0 indicates there are cached samples that
- * can be retrieved with subsequent calls to ff_rm_retrieve_cache()),
- * errno codes on error
+ * @return <0 on error, 0 if a packet was placed in the \p pkt pointer. A
+ * value >0 means that no data was placed in \p pkt, but that cached
+ * data is available by calling ff_rm_retrieve_cache().
*/
int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,
AVStream *st, RMStream *rst, int len,