4 <title>libogg - function - ogg_sync_wrote</title>
5 <link rel=stylesheet href="style.css" type="text/css">
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
11 <td><p class=tiny>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
16 <h1>ogg_sync_wrote</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function is used to tell the <a href="ogg_sync_state.html">ogg_sync_state</a> struct how many bytes we wrote into the buffer.
23 The general proceedure is to request a pointer into an internal
24 <a href="ogg_sync_state.html">ogg_sync_state</a> buffer by calling
25 <a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. The buffer
26 is then filled up to the requested size with new input, and
27 ogg_sync_wrote() is called to advance the fill pointer by however
28 much data was actually available.</p>
31 <table border=0 color=black cellspacing=0 cellpadding=7>
35 int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long bytes);
44 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
46 <dd>Number of bytes of new data written.</dd>
50 <h3>Return Values</h3>
52 <li>-1 if the number of bytes written overflows the internal storage of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct or an internal error occurred.
54 0 in all other cases.</li>
60 <table border=0 width=100%>
62 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
63 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
65 <td><p class=tiny>libogg documentation</p></td>
66 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>