EVOLUTION-MANAGER
Edit File: ogg_sync_pageout.html
<html> <head> <title>libogg - function - ogg_sync_pageout</title> <link rel=stylesheet href="style.css" type="text/css"> </head> <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> <table border=0 width=100%> <tr> <td><p class=tiny>libogg documentation</p></td> <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> </tr> </table> <h1>ogg_sync_pageout</h1> <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><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> <table border=0 color=black cellspacing=0 cellpadding=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); </b></pre> </td> </tr> </table> <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 page struct filled by this function. </dl> <h3>Return Values</h3> <blockquote> <li>-1 returned if stream has not yet captured sync (bytes were skipped).</li> <li>0 returned if more data needed or an internal error occurred.</li> <li>1 indicated a page was synced and returned.</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); } </pre> <br><br> <hr noshade> <table border=0 width=100%> <tr valign=top> <td><p class=tiny>copyright © 2000-2011 Xiph.Org</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.3.0 - 20110804</p></td> </tr> </table> </body> </html>