[xiph-commits] r7889 - trunk/ogg/doc/ogg

[giles at motherfish-iii.xiph.org]

Author: giles
Date: 2004-09-27 23:21:08 -0700 (Mon, 27 Sep 2004)
New Revision: 7889

Modified:
   trunk/ogg/doc/ogg/ogg_stream_packetout.html
Log:
additional verbosity on ogg_stream_packetout()

Modified: trunk/ogg/doc/ogg/ogg_stream_packetout.html
===================================================================
--- trunk/ogg/doc/ogg/ogg_stream_packetout.html	2004-09-28 06:06:31 UTC (rev 7888)
+++ trunk/ogg/doc/ogg/ogg_stream_packetout.html	2004-09-28 06:21:08 UTC (rev 7889)
@@ -17,8 +17,8 @@
 
 <p><i>declared in "ogg/ogg.h";</i></p>
 
-<p>This function assembles a raw data packet for output to the codec decoding engine. The data is already in the stream and broken into packet segments.</p>
-<p>In a typical decoding situation, this should be used after calling <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a page of data to the bitstream.</p>
+<p>This function assembles a raw data packet for output to the codec decoding engine. The data is already in the stream and broken into packet segments. Each successive call returns the next complete packet built from those segments.</p>
+<p>In a typical decoding situation, this should be used after calling <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a page of data to the bitstream. If the function returns 0, more data is needed and another page should be submitted. A non-zero return value indicates successful return of a packet.</p>
 
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
@@ -46,9 +46,9 @@
 <h3>Return Values</h3>
 <blockquote>
 <ul>
-<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error.</li>
-<li>0 if there is no data available, or only a partial packet.
-<li>1 in all other cases.</li>
+<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error. <i>op</i> contains a the first packet decodable after the hole.</li>
+<li>0 if there is insufficient data available to complete a packet. <i>op</i> has not been updated.
+<li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li>
 </ul>
 </blockquote>
 
@@ -58,7 +58,7 @@
 
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
+<td><p class=tiny>copyright &copy; 2004 xiph.org</p></td>
 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at xiph.org">team at xiph.org</a></p></td>
 </tr><tr>
 <td><p class=tiny>libogg documentation</p></td>