diff options
Diffstat (limited to 'doc/ogg/ogg_sync_pageout.html')
-rw-r--r-- | doc/ogg/ogg_sync_pageout.html | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/ogg/ogg_sync_pageout.html b/doc/ogg/ogg_sync_pageout.html index 381f560..ab3dec9 100644 --- a/doc/ogg/ogg_sync_pageout.html +++ b/doc/ogg/ogg_sync_pageout.html @@ -17,9 +17,9 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function takes the data stored in the buffer of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct and inserts them into an <a href="ogg_page.html">ogg_page</a>.
-
-<p>In an actual decoding loop, this function should be called first to ensure that the buffer is cleared. The example code below illustrates a clean reading loop which will fill and output pages.
+<p>This function takes the data stored in the buffer of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct and inserts them into an <a href="ogg_page.html">ogg_page</a>. + +<p>In an actual decoding loop, this function should be called first to ensure that the buffer is cleared. The example code below illustrates a clean reading loop which will fill and output pages. <p><b>Caution:</b>This function should be called before reading into the buffer to ensure that data does not remain in the ogg_sync_state struct. Failing to do so may result in a memory leak. See the example code below for details. <br><br> @@ -27,7 +27,7 @@ <tr bgcolor=#cccccc> <td> <pre><b> -int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og);
+int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og); </b></pre> </td> </tr> @@ -36,29 +36,29 @@ int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a hr <h3>Parameters</h3> <dl> <dt><i>oy</i></dt> -<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct. Normally, the internal storage of this struct should be filled with newly read data and verified using <a href="ogg_sync_wrote.html">ogg_sync_wrote</a>.</dd>
-<dt><i>og</i></dt>
+<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct. Normally, the internal storage of this struct should be filled with newly read data and verified using <a href="ogg_sync_wrote.html">ogg_sync_wrote</a>.</dd> +<dt><i>og</i></dt> <dd>Pointer to page struct filled by this function. </dl> <h3>Return Values</h3> <blockquote> -<li>-1 if we were not properly synced and had to skip some bytes.</li>
+<li>-1 if we were not properly synced and had to skip some bytes.</li> +<li> +0 if we need more data to verify a page.</li> <li> -0 if we need more data to verify a page.</li>
-<li>
1 if we have a page.</li> </blockquote> -<p>
-
-<h3>Example Usage</h3>
-<pre>
-if (ogg_sync_pageout(&oy, &og) != 1) {
- buffer = ogg_sync_buffer(&oy, 8192);
- bytes = fread(buffer, 1, 8192, stdin);
- ogg_sync_wrote(&oy, bytes);
-}
+<p> + +<h3>Example Usage</h3> +<pre> +if (ogg_sync_pageout(&oy, &og) != 1) { + buffer = ogg_sync_buffer(&oy, 8192); + bytes = fread(buffer, 1, 8192, stdin); + ogg_sync_wrote(&oy, bytes); +} </pre> <br><br> |