00001 <html>
00002
00003 <head>
00004 <title>Vorbisfile - function - ov_clear</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>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ov_clear</h1>
00017
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019
00020 <p> After a bitstream has been opened using <a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
00021 the decoder's buffers. <tt>ov_clear()</tt> will also close the file.<p>
00022
00023 <tt>ov_clear()</tt> must also be called after a successful call to <a href="ov_test.html">ov_test()</a> or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.<p>
00024
00025 <br><br>
00026 <table border=0 color=black cellspacing=0 cellpadding=7>
00027 <tr bgcolor=#cccccc>
00028 <td>
00029 <pre><b>
00030 int ov_clear(OggVorbis_File *vf);
00031 </b></pre>
00032 </td>
00033 </tr>
00034 </table>
00035
00036 <h3>Parameters</h3>
00037 <dl>
00038 <dt><i>vf</i></dt>
00039 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
00040 functions. After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd>
00041 </dl>
00042
00043
00044 <h3>Return Values</h3>
00045 <blockquote>
00046 <li>0 for success</li>
00047 </blockquote>
00048
00049
00050 <br><br>
00051 <hr noshade>
00052 <table border=0 width=100%>
00053 <tr valign=top>
00054 <td><p class=tiny>copyright © 2003 Xiph.org</p></td>
00055 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00056 </tr><tr>
00057 <td><p class=tiny>Vorbisfile documentation</p></td>
00058 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00059 </tr>
00060 </table>
00061
00062 </body>
00063
00064 </html>
