diff options
author | Ralph Giles <giles@xiph.org> | 2006-03-11 07:45:56 +0000 |
---|---|---|
committer | Ralph Giles <giles@xiph.org> | 2006-03-11 07:45:56 +0000 |
commit | 13a4adf500033867c0b089647f039048f9adb174 (patch) | |
tree | 1520838e8f2249f0fdcde67b220252249c2c2727 /doc/libogg | |
parent | 30a0ce2f00ee12965157021d4b8f3d162000139b (diff) | |
download | ogg-13a4adf500033867c0b089647f039048f9adb174.tar.gz |
Correct cut-and-paste errors and further clarify memory ownership in the
documentation for ogg_stream_pageout().
git-svn-id: http://svn.xiph.org/trunk/ogg@10993 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc/libogg')
-rw-r--r-- | doc/libogg/ogg_stream_pageout.html | 35 |
1 files changed, 26 insertions, 9 deletions
diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html index c703382..1894391 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.0 - 20000615</p></td> +<td align=right><p class=tiny>libogg release 1.1.4 - 20060310</p></td> </tr> </table> @@ -17,9 +17,22 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function forms packets into pages. If - <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. -<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. +<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 +to a stream.</p> + +<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 +bitrate stream.</p> <br><br> <table border=0 color=black cellspacing=0 cellpadding=7> @@ -37,14 +50,18 @@ int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <dt><i>os</i></dt> <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 a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets. +<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 +ogg_stream_flush().</dd> </dl> <h3>Return Values</h3> <blockquote> -<li>Zero means that insufficient data has accumulated to fill a page.</li> -<li>Non-zero means that a page has been completed and flushed.</li> +<li>Zero means that insufficient data has accumulated to fill a page. In +this case <i>og</i> is not modified.</li> +<li>Non-zero means that a page has been completed and returned.</li> </blockquote> <p> @@ -52,11 +69,11 @@ int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <hr noshade> <table border=0 width=100%> <tr valign=top> -<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td><p class=tiny>copyright © 2000-2006 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@xiph.org">team@xiph.org</a></p></td> </tr><tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> +<td align=right><p class=tiny>libogg release 1.1.4 - 20060310</p></td> </tr> </table> |