Mercurial > hg > sv-dependency-builds
comparison src/libvorbis-1.3.3/doc/vorbisfile/ov_clear.html @ 1:05aa0afa9217
Bring in flac, ogg, vorbis
| author | Chris Cannam |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 0:c7265573341e | 1:05aa0afa9217 |
|---|---|
| 1 <html> | |
| 2 | |
| 3 <head> | |
| 4 <title>Vorbisfile - function - ov_clear</title> | |
| 5 <link rel=stylesheet href="style.css" type="text/css"> | |
| 6 </head> | |
| 7 | |
| 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> | |
| 9 <table border=0 width=100%> | |
| 10 <tr> | |
| 11 <td><p class=tiny>Vorbisfile documentation</p></td> | |
| 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> | |
| 13 </tr> | |
| 14 </table> | |
| 15 | |
| 16 <h1>ov_clear</h1> | |
| 17 | |
| 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p> | |
| 19 | |
| 20 <p> After a bitstream has been opened using <a href="ov_fopen.html">ov_fopen()</a>/<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 | |
| 21 the decoder's buffers. <tt>ov_clear()</tt> will also close the file unless it was opened using <a href="ov_open_callbacks.html">ov_open_callbacks()</a> with the <tt>close_func</tt> callback set to NULL.<p> | |
| 22 | |
| 23 <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> | |
| 24 | |
| 25 <br><br> | |
| 26 <table border=0 color=black cellspacing=0 cellpadding=7> | |
| 27 <tr bgcolor=#cccccc> | |
| 28 <td> | |
| 29 <pre><b> | |
| 30 int ov_clear(OggVorbis_File *vf); | |
| 31 </b></pre> | |
| 32 </td> | |
| 33 </tr> | |
| 34 </table> | |
| 35 | |
| 36 <h3>Parameters</h3> | |
| 37 <dl> | |
| 38 <dt><i>vf</i></dt> | |
| 39 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile | |
| 40 functions. After <tt>ov_clear</tt> has been called, the contents of this structure are deallocated, and it can no longer be used without being reinitialized by a call to <a href="ov_fopen.html">ov_fopen()</a>, <a href="ov_open.html">ov_open()</a> or <a href="ov_open_callbacks.html">ov_open_callbacks()</a>.</dd> | |
| 41 </dl> | |
| 42 | |
| 43 | |
| 44 <h3>Return Values</h3> | |
| 45 <blockquote> | |
| 46 <li>0 for success</li> | |
| 47 </blockquote> | |
| 48 | |
| 49 | |
| 50 <br><br> | |
| 51 <hr noshade> | |
| 52 <table border=0 width=100%> | |
| 53 <tr valign=top> | |
| 54 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> | |
| 55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> | |
| 56 </tr><tr> | |
| 57 <td><p class=tiny>Vorbisfile documentation</p></td> | |
| 58 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> | |
| 59 </tr> | |
| 60 </table> | |
| 61 | |
| 62 </body> | |
| 63 | |
| 64 </html> |