annotate src/libogg-1.3.0/doc/libogg/ogg_sync_wrote.html @ 83:ae30d91d2ffe

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