diff options
Diffstat (limited to 'doc/libogg/ogg_stream_pageout.html')
| -rw-r--r-- | doc/libogg/ogg_stream_pageout.html | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html index c07a975..9915368 100644 --- a/doc/libogg/ogg_stream_pageout.html +++ b/doc/libogg/ogg_stream_pageout.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> @@ -19,20 +19,20 @@ <p>This function forms packets into pages.</p> -<p>In a typical encoding situation, this would be called after using <a -href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit -data packets to the bitstream. Internally, this function assembles -the accumulated packet bodies into an Ogg page suitable for writing +<p>In a typical encoding situation, this would be called after using <a +href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit +data packets to the bitstream. Internally, this function assembles +the accumulated packet bodies into an Ogg page suitable for writing to a stream. The function is typically called in a loop until there are no more pages ready for output.</p> -<p>This function will only return a page when a "reasonable" amount of -packet data is available. Normally this is appropriate since it +<p>This function will only return a page when a "reasonable" amount of +packet data is available. Normally this is appropriate since it limits the overhead of the Ogg page headers in the bitstream, and so -calling ogg_stream_pageout() after ogg_stream_packetin() should be the -common case. Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a> -if immediate page generation is desired. This may be occasionally -necessary, for example, to limit the temporal latency of a variable +calling ogg_stream_pageout() after ogg_stream_packetin() should be the +common case. Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a> +if immediate page generation is desired. This may be occasionally +necessary, for example, to limit the temporal latency of a variable bitrate stream.</p> <br><br> @@ -52,15 +52,15 @@ int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd> <dt><i>og</i></dt> <dd>Pointer to an <a href="ogg_page.html">ogg_page</a> structure to fill -in. Data pointed to is owned by libogg. The structure is valid until the -next call to ogg_stream_pageout(), ogg_stream_packetin(), or +in. Data pointed to is owned by libogg. The structure is valid until the +next call to ogg_stream_pageout(), ogg_stream_packetin(), or ogg_stream_flush().</dd> </dl> <h3>Return Values</h3> <blockquote> -<li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In +<li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In this case <i>og</i> is not modified.</li> <li>Non-zero means that a page has been completed and returned.</li> </blockquote> @@ -70,11 +70,11 @@ this case <i>og</i> is not modified.</li> <hr noshade> <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> |