Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/ogg_sync_wrote.html @ 86:98c1576536ae
Bring in flac, ogg, vorbis
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
| rev | line source |
|---|---|
| cannam@86 | 1 <html> |
| cannam@86 | 2 |
| cannam@86 | 3 <head> |
| cannam@86 | 4 <title>libogg - function - ogg_sync_wrote</title> |
| cannam@86 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| cannam@86 | 6 </head> |
| cannam@86 | 7 |
| cannam@86 | 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| cannam@86 | 9 <table border=0 width=100%> |
| cannam@86 | 10 <tr> |
| cannam@86 | 11 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 13 </tr> |
| cannam@86 | 14 </table> |
| cannam@86 | 15 |
| cannam@86 | 16 <h1>ogg_sync_wrote</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "ogg/ogg.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 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. |
| cannam@86 | 21 |
| cannam@86 | 22 <p> |
| cannam@86 | 23 The general proceedure is to request a pointer into an internal |
| cannam@86 | 24 <a href="ogg_sync_state.html">ogg_sync_state</a> buffer by calling |
| cannam@86 | 25 <a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. The buffer |
| cannam@86 | 26 is then filled up to the requested size with new input, and |
| cannam@86 | 27 ogg_sync_wrote() is called to advance the fill pointer by however |
| cannam@86 | 28 much data was actually available.</p> |
| cannam@86 | 29 |
| cannam@86 | 30 <br> |
| cannam@86 | 31 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 32 <tr bgcolor=#cccccc> |
| cannam@86 | 33 <td> |
| cannam@86 | 34 <pre><b> |
| cannam@86 | 35 int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long bytes); |
| cannam@86 | 36 </b></pre> |
| cannam@86 | 37 </td> |
| cannam@86 | 38 </tr> |
| cannam@86 | 39 </table> |
| cannam@86 | 40 |
| cannam@86 | 41 <h3>Parameters</h3> |
| cannam@86 | 42 <dl> |
| cannam@86 | 43 <dt><i>oy</i></dt> |
| cannam@86 | 44 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> |
| cannam@86 | 45 <dt><i>bytes</i></dt> |
| cannam@86 | 46 <dd>Number of bytes of new data written.</dd> |
| cannam@86 | 47 </dl> |
| cannam@86 | 48 |
| cannam@86 | 49 |
| cannam@86 | 50 <h3>Return Values</h3> |
| cannam@86 | 51 <blockquote> |
| cannam@86 | 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. |
| cannam@86 | 53 <li> |
| cannam@86 | 54 0 in all other cases.</li> |
| cannam@86 | 55 </blockquote> |
| cannam@86 | 56 |
| cannam@86 | 57 |
| cannam@86 | 58 <br><br> |
| cannam@86 | 59 <hr noshade> |
| cannam@86 | 60 <table border=0 width=100%> |
| cannam@86 | 61 <tr valign=top> |
| cannam@86 | 62 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> |
| cannam@86 | 63 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| cannam@86 | 64 </tr><tr> |
| cannam@86 | 65 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 66 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 67 </tr> |
| cannam@86 | 68 </table> |
| cannam@86 | 69 |
| cannam@86 | 70 |
| cannam@86 | 71 </body> |
| cannam@86 | 72 |
| cannam@86 | 73 </html> |