changeset 3174:e5c7e9eac774 libavformat

Document get_*_buffer()
author michael
date Fri, 21 Mar 2008 22:17:56 +0000
parents cb3eb255f80d
children 55ce214a13ea
files avio.h
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/avio.h	Fri Mar 21 14:30:45 2008 +0000
+++ b/avio.h	Fri Mar 21 22:17:56 2008 +0000
@@ -260,7 +260,19 @@
 
 void put_flush_packet(ByteIOContext *s);
 
+
+/**
+ * Reads size bytes from ByteIOContext into buf.
+ * @returns number of bytes read or AVERROR
+ */
 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
+
+/**
+ * Reads size bytes from ByteIOContext into buf.
+ * This reads at most 1 packet. If thats not enough fewer bytes will be
+ * returned.
+ * @returns number of bytes read or AVERROR
+ */
 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
 
 /** @note return 0 if EOF, so you cannot use it if EOF handling is