Mercurial > hg > sv-dependency-builds
annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_test_open.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_test_open</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_test_open</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 20 <p> |
| cannam@86 | 21 Finish opening a file partially opened with <a href="ov_test.html">ov_test()</a> |
| cannam@86 | 22 or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>. |
| cannam@86 | 23 <p> |
| cannam@86 | 24 |
| cannam@86 | 25 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 26 <tr bgcolor=#cccccc> |
| cannam@86 | 27 <td> |
| cannam@86 | 28 <pre><b> |
| cannam@86 | 29 int ov_test_open(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf); |
| cannam@86 | 30 </b></pre> |
| cannam@86 | 31 </td> |
| cannam@86 | 32 </tr> |
| cannam@86 | 33 </table> |
| cannam@86 | 34 |
| cannam@86 | 35 <h3>Parameters</h3> |
| cannam@86 | 36 <dl> |
| cannam@86 | 37 <dt><i>vf</i></dt> |
| cannam@86 | 38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile |
| cannam@86 | 39 functions. Once this has been called, the same <tt>OggVorbis_File</tt> |
| cannam@86 | 40 struct should be passed to all the libvorbisfile functions.</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> |
| cannam@86 | 47 0 for success</li> |
| cannam@86 | 48 |
| cannam@86 | 49 <li>less than zero for failure:</li> |
| cannam@86 | 50 <ul> |
| cannam@86 | 51 <li>OV_EREAD - A read from media returned an error.</li> |
| cannam@86 | 52 <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li> |
| cannam@86 | 53 <li>OV_EVERSION - Vorbis version mismatch.</li> |
| cannam@86 | 54 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li> |
| cannam@86 | 55 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li> |
| cannam@86 | 56 </ul> |
| cannam@86 | 57 </blockquote> |
| cannam@86 | 58 <p> |
| cannam@86 | 59 |
| cannam@86 | 60 |
| cannam@86 | 61 <br><br> |
| cannam@86 | 62 <hr noshade> |
| cannam@86 | 63 <table border=0 width=100%> |
| cannam@86 | 64 <tr valign=top> |
| cannam@86 | 65 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> |
| cannam@86 | 66 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| cannam@86 | 67 </tr><tr> |
| cannam@86 | 68 <td><p class=tiny>Vorbisfile documentation</p></td> |
| cannam@86 | 69 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> |
| cannam@86 | 70 </tr> |
| cannam@86 | 71 </table> |
| cannam@86 | 72 |
| cannam@86 | 73 </body> |
| cannam@86 | 74 |
| cannam@86 | 75 </html> |
| cannam@86 | 76 |
| cannam@86 | 77 |
| cannam@86 | 78 |
| cannam@86 | 79 |
| cannam@86 | 80 |
| cannam@86 | 81 |
| cannam@86 | 82 |