annotate 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 |
|
| rev |
line source |
|
Chris@1
|
1 <html>
|
|
Chris@1
|
2
|
|
Chris@1
|
3 <head>
|
|
Chris@1
|
4 <title>Vorbisfile - function - ov_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>Vorbisfile documentation</p></td>
|
|
Chris@1
|
12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|
Chris@1
|
13 </tr>
|
|
Chris@1
|
14 </table>
|
|
Chris@1
|
15
|
|
Chris@1
|
16 <h1>ov_clear</h1>
|
|
Chris@1
|
17
|
|
Chris@1
|
18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
|
|
Chris@1
|
19
|
|
Chris@1
|
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
|
|
Chris@1
|
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>
|
|
Chris@1
|
22
|
|
Chris@1
|
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>
|
|
Chris@1
|
24
|
|
Chris@1
|
25 <br><br>
|
|
Chris@1
|
26 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
Chris@1
|
27 <tr bgcolor=#cccccc>
|
|
Chris@1
|
28 <td>
|
|
Chris@1
|
29 <pre><b>
|
|
Chris@1
|
30 int ov_clear(OggVorbis_File *vf);
|
|
Chris@1
|
31 </b></pre>
|
|
Chris@1
|
32 </td>
|
|
Chris@1
|
33 </tr>
|
|
Chris@1
|
34 </table>
|
|
Chris@1
|
35
|
|
Chris@1
|
36 <h3>Parameters</h3>
|
|
Chris@1
|
37 <dl>
|
|
Chris@1
|
38 <dt><i>vf</i></dt>
|
|
Chris@1
|
39 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
|
|
Chris@1
|
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>
|
|
Chris@1
|
41 </dl>
|
|
Chris@1
|
42
|
|
Chris@1
|
43
|
|
Chris@1
|
44 <h3>Return Values</h3>
|
|
Chris@1
|
45 <blockquote>
|
|
Chris@1
|
46 <li>0 for success</li>
|
|
Chris@1
|
47 </blockquote>
|
|
Chris@1
|
48
|
|
Chris@1
|
49
|
|
Chris@1
|
50 <br><br>
|
|
Chris@1
|
51 <hr noshade>
|
|
Chris@1
|
52 <table border=0 width=100%>
|
|
Chris@1
|
53 <tr valign=top>
|
|
Chris@1
|
54 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
|
|
Chris@1
|
55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
|
|
Chris@1
|
56 </tr><tr>
|
|
Chris@1
|
57 <td><p class=tiny>Vorbisfile documentation</p></td>
|
|
Chris@1
|
58 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|
Chris@1
|
59 </tr>
|
|
Chris@1
|
60 </table>
|
|
Chris@1
|
61
|
|
Chris@1
|
62 </body>
|
|
Chris@1
|
63
|
|
Chris@1
|
64 </html>
|
