diff options
Diffstat (limited to 'doc/libogg/ogg_stream_packetout.html')
| -rw-r--r-- | doc/libogg/ogg_stream_packetout.html | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html index fc7ffad..6e12dc9 100644 --- a/doc/libogg/ogg_stream_packetout.html +++ b/doc/libogg/ogg_stream_packetout.html @@ -9,7 +9,7 @@ <table border=0 width=100%> <tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td> +<td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td> </tr> </table> @@ -17,16 +17,16 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function assembles a data packet for output to the codec +<p>This function assembles a data packet for output to the codec decoding engine. The data has already been submitted to the <a href="ogg_stream_state.html">ogg_stream_state</a> and broken -into segments. Each successive call returns the next complete packet +into 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 +<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> <p>The <i>op</i> is filled in with pointers to memory managed by @@ -50,8 +50,8 @@ int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op); <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this function is called, an <a href="ogg_page.html">ogg_page</a> should be submitted to the stream using <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd> <dt><i>op</i></dt> -<dd>Pointer to the packet to be filled in with pointers to the new data. -This will typically be submitted to a codec for decode after this +<dd>Pointer to the packet to be filled in with pointers to the new data. +This will typically be submitted to a codec for decode after this function is called. The pointers are only valid until the next call on this stream state.</dd> </dl> @@ -72,11 +72,11 @@ on this stream state.</dd> <table border=0 width=100%> <tr valign=top> -<td><p class=tiny>copyright © 2000-2010 xiph.org</p></td> +<td><p class=tiny>copyright © 2000-2021 Xiph.Org Foundation</p></td> <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> </tr><tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td> +<td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td> </tr> </table> |