annotate src/libogg-1.3.0/doc/libogg/ogg_stream_clear.html @ 1:05aa0afa9217

Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libogg - function - ogg_stream_clear</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_stream_clear</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 clears and frees the internal memory used by the <a href="ogg_sync_state.html">ogg_stream_state</a> struct, but does not free the structure itself. It is safe to call ogg_stream_clear on the same structure more than once.
Chris@1 21 <br><br>
Chris@1 22 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 23 <tr bgcolor=#cccccc>
Chris@1 24 <td>
Chris@1 25 <pre><b>
Chris@1 26 int ogg_stream_clear(ogg_stream_state *os);
Chris@1 27 </b></pre>
Chris@1 28 </td>
Chris@1 29 </tr>
Chris@1 30 </table>
Chris@1 31
Chris@1 32 <h3>Parameters</h3>
Chris@1 33 <dl>
Chris@1 34 <dt><i>os</i></dt>
Chris@1 35 <dd>Pointer to the ogg_stream_state struct to be cleared.</dd>
Chris@1 36 </dl>
Chris@1 37
Chris@1 38
Chris@1 39 <h3>Return Values</h3>
Chris@1 40 <blockquote>
Chris@1 41 <li>
Chris@1 42 0 is always returned.</li>
Chris@1 43 </blockquote>
Chris@1 44 <p>
Chris@1 45
Chris@1 46 <br><br>
Chris@1 47 <hr noshade>
Chris@1 48 <table border=0 width=100%>
Chris@1 49 <tr valign=top>
Chris@1 50 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
Chris@1 51 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
Chris@1 52 </tr><tr>
Chris@1 53 <td><p class=tiny>libogg documentation</p></td>
Chris@1 54 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 55 </tr>
Chris@1 56 </table>
Chris@1 57
Chris@1 58
Chris@1 59 </body>
Chris@1 60
Chris@1 61 </html>