Home | History | Annotate | Download | only in vorbisfile
      1 <html>
      2 
      3 <head>
      4 <title>Vorbisfile - Return Codes</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.2.0 - 20070723</p></td>
     13 </tr>
     14 </table>
     15 
     16 <h1>Return Codes</h1>
     17 
     18 <p>
     19 
     20 The following return codes are <tt>#define</tt>d in "vorbis/codec.h"
     21 may be returned by libvorbisfile.  Descriptions of a code relevant to
     22 a specific function are found in the reference description of that
     23 function.
     24 
     25 <dl>
     26 
     27 <dt>OV_FALSE</dt>
     28 <dd>Not true, or no data available</dd>
     29 
     30 <dt>OV_HOLE</dt>
     31 <dd>Vorbisfile encoutered missing or corrupt data in the bitstream.  Recovery
     32 is normally automatic and this return code is for informational purposes only.</dd>
     33 
     34 <dt>OV_EREAD</dt>
     35 <dd>Read error while fetching compressed data for decode</dd>
     36 
     37 <dt>OV_EFAULT</dt>
     38 <dd>Internal inconsistency in decode state.  Continuing is likely not possible.</dd>
     39 
     40 <dt>OV_EIMPL</dt>
     41 <dd>Feature not implemented</dd>
     42 
     43 <dt>OV_EINVAL</dt>
     44 <dd>Either an invalid argument, or incompletely initialized argument passed to libvorbisfile call</dd>
     45 
     46 <dt>OV_ENOTVORBIS</dt>
     47 <dd>The given file/data was not recognized as Ogg Vorbis data.</dd>
     48 
     49 <dt>OV_EBADHEADER</dt>
     50 <dd>The file/data is apparently an Ogg Vorbis stream, but contains a corrupted or undecipherable header.</dd>
     51 
     52 <dt>OV_EVERSION</dt>
     53 <dd>The bitstream format revision of the given stream is not supported.</dd>
     54 
     55 <dt>OV_EBADLINK</dt>
     56 <dd>The given link exists in the Vorbis data stream, but is not decipherable due to garbacge or corruption.</dd>
     57 
     58 <dt>OV_ENOSEEK</dt>
     59 <dd>The given stream is not seekable</dd>
     60 
     61 </dl>
     62 
     63 <br><br>
     64 <hr noshade>
     65 <table border=0 width=100%>
     66 <tr valign=top>
     67 <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
     68 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
     69 </tr><tr>
     70 <td><p class=tiny>Vorbisfile documentation</p></td>
     71 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
     72 </tr>
     73 </table>
     74 
     75 </body>
     76 
     77 </html>
     78