00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_sync_buffer</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_sync_buffer</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function is used to provide a properly-sized buffer for writing.
00021 <p>Buffer space which has already been returned is cleared, and the buffer is extended as necessary by the size plus some additional bytes. Within the current implementation, an extra 4096 bytes are allocated, but applications should not rely on this additional buffer space.
00022 <p>The buffer exposed by this function is empty internal storage from the <a href="ogg_sync_state.html">ogg_sync_state</a> struct, beginning at the fill mark within the struct.
00023 <p>A pointer to this buffer is returned to be used by the calling application.
00024
00025 <br><br>
00026 <table border=0 color=black cellspacing=0 cellpadding=7>
00027 <tr bgcolor=#cccccc>
00028 <td>
00029 <pre><b>
00030 char *ogg_sync_buffer(ogg_sync_state *oy, long size);
00031 </b></pre>
00032 </td>
00033 </tr>
00034 </table>
00035
00036 <h3>Parameters</h3>
00037 <dl>
00038 <dt><i>oy</i></dt>
00039 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
00040 <dt><i>size</i></dt>
00041 <dd>Size of the desired buffer. The actual size of the buffer returned will be this size plus some extra bytes (currently 4096).
00042 </dl>
00043
00044
00045 <h3>Return Values</h3>
00046 <blockquote>
00047 <li>
00048 Returns a pointer to the newly allocated buffer.</li>
00049 </blockquote>
00050 <p>
00051
00052 <br><br>
00053 <hr noshade>
00054 <table border=0 width=100%>
00055 <tr valign=top>
00056 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00057 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00058 </tr><tr>
00059 <td><p class=tiny>libogg documentation</p></td>
00060 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00061 </tr>
00062 </table>
00063
00064
00065 </body>
00066
00067 </html>
