summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authoroggk <oggk@xiph.org>2009-04-04 15:22:40 +0000
committeroggk <oggk@xiph.org>2009-04-04 15:22:40 +0000
commit3008150070484419b3de18a69df8d061e1343416 (patch)
treeceb0d9596d68c1d3f624237a407271aaab396148 /doc
parentacf3ff100ad2c240c10b4528ba259ecd08a3c712 (diff)
downloadogg-3008150070484419b3de18a69df8d061e1343416.tar.gz
fix implication that op is updated when -1 is returned.
git-svn-id: http://svn.xiph.org/trunk/ogg@15906 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc')
-rw-r--r--doc/libogg/ogg_stream_packetout.html2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html
index ac91cc8..8563849 100644
--- a/doc/libogg/ogg_stream_packetout.html
+++ b/doc/libogg/ogg_stream_packetout.html
@@ -60,7 +60,7 @@ on this stream state.</dd>
<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. <i>op</i> contains a the first packet decodable after the hole.</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 and subsequent calls to ogg_stream_packetout are likely to succeed. <i>op</i> has not been updated.</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>