Mercurial > hg > sv-dependency-builds
annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_clear.html @ 86:98c1576536ae
Bring in flac, ogg, vorbis
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
| rev | line source |
|---|---|
| cannam@86 | 1 <html> |
| cannam@86 | 2 |
| cannam@86 | 3 <head> |
| cannam@86 | 4 <title>Vorbisfile - function - ov_clear</title> |
| cannam@86 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| cannam@86 | 6 </head> |
| cannam@86 | 7 |
| cannam@86 | 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| cannam@86 | 9 <table border=0 width=100%> |
| cannam@86 | 10 <tr> |
| cannam@86 | 11 <td><p class=tiny>Vorbisfile documentation</p></td> |
| cannam@86 | 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> |
| cannam@86 | 13 </tr> |
| cannam@86 | 14 </table> |
| cannam@86 | 15 |
| cannam@86 | 16 <h1>ov_clear</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 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 |
| cannam@86 | 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> |
| cannam@86 | 22 |
| cannam@86 | 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> |
| cannam@86 | 24 |
| cannam@86 | 25 <br><br> |
| cannam@86 | 26 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 27 <tr bgcolor=#cccccc> |
| cannam@86 | 28 <td> |
| cannam@86 | 29 <pre><b> |
| cannam@86 | 30 int ov_clear(OggVorbis_File *vf); |
| cannam@86 | 31 </b></pre> |
| cannam@86 | 32 </td> |
| cannam@86 | 33 </tr> |
| cannam@86 | 34 </table> |
| cannam@86 | 35 |
| cannam@86 | 36 <h3>Parameters</h3> |
| cannam@86 | 37 <dl> |
| cannam@86 | 38 <dt><i>vf</i></dt> |
| cannam@86 | 39 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile |
| cannam@86 | 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> |
| cannam@86 | 41 </dl> |
| cannam@86 | 42 |
| cannam@86 | 43 |
| cannam@86 | 44 <h3>Return Values</h3> |
| cannam@86 | 45 <blockquote> |
| cannam@86 | 46 <li>0 for success</li> |
| cannam@86 | 47 </blockquote> |
| cannam@86 | 48 |
| cannam@86 | 49 |
| cannam@86 | 50 <br><br> |
| cannam@86 | 51 <hr noshade> |
| cannam@86 | 52 <table border=0 width=100%> |
| cannam@86 | 53 <tr valign=top> |
| cannam@86 | 54 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> |
| cannam@86 | 55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| cannam@86 | 56 </tr><tr> |
| cannam@86 | 57 <td><p class=tiny>Vorbisfile documentation</p></td> |
| cannam@86 | 58 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> |
| cannam@86 | 59 </tr> |
| cannam@86 | 60 </table> |
| cannam@86 | 61 |
| cannam@86 | 62 </body> |
| cannam@86 | 63 |
| cannam@86 | 64 </html> |