examples/sfexamples/oggvorbiscodec/src/tremor/doc/return.html

00001 <html>
00002 
00003 <head>
00004 <title>Tremor - Return Codes</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Tremor documentation</p></td>
00012 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>Return Codes</h1>
00017 
00018 <p>
00019 
00020 The following return codes are <tt>#define</tt>d in "ivorbiscodec.h"
00021 may be returned by libvorbisidec.  Descriptions of a code relevant to
00022 a specific function are found in the reference description of that
00023 function.
00024 
00025 <dl>
00026 
00027 <dt>OV_FALSE</dt>
00028 <dd>Not true, or no data available</dd>
00029 
00030 <dt>OV_HOLE</dt>
00031 <dd>Tremor encoutered missing or corrupt data in the bitstream.  Recovery
00032 is normally automatic and this return code is for informational purposes only.</dd>
00033 
00034 <dt>OV_EREAD</dt>
00035 <dd>Read error while fetching compressed data for decode</dd>
00036 
00037 <dt>OV_EFAULT</dt>
00038 <dd>Internal inconsistency in decode state.  Continuing is likely not possible.</dd>
00039 
00040 <dt>OV_EIMPL</dt>
00041 <dd>Feature not implemented</dd>
00042 
00043 <dt>OV_EINVAL</dt>
00044 <dd>Either an invalid argument, or incompletely initialized argument passed to libvorbisidec call</dd>
00045 
00046 <dt>OV_ENOTVORBIS</dt>
00047 <dd>The given file/data was not recognized as Ogg Vorbis data.</dd>
00048 
00049 <dt>OV_EBADHEADER</dt>
00050 <dd>The file/data is apparently an Ogg Vorbis stream, but contains a corrupted or undecipherable header.</dd>
00051 
00052 <dt>OV_EVERSION</dt>
00053 <dd>The bitstream format revision of the given stream is not supported.</dd>
00054 
00055 <dt>OV_EBADLINK</dt>
00056 <dd>The given link exists in the Vorbis data stream, but is not decipherable due to garbacge or corruption.</dd>
00057 
00058 <dt>OV_ENOSEEK</dt>
00059 <dd>The given stream is not seekable</dd>
00060 
00061 </dl>
00062 
00063 <br><br>
00064 <hr noshade>
00065 <table border=0 width=100%>
00066 <tr valign=top>
00067 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
00068 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00069 </tr><tr>
00070 <td><p class=tiny>Tremor documentation</p></td>
00071 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00072 </tr>
00073 </table>
00074 
00075 </body>
00076 
00077 </html>

Generated by  doxygen 1.6.2