examples/sfexamples/oggvorbiscodec/src/libogg/doc/ogg/oggpack_read1.html

00001 <html>
00002 
00003 <head>
00004 <title>libogg - function - oggpack_read1</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>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>oggpack_read1</h1>
00017 
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019 
00020 <p>This function reads one bit from the <a href="oggpack_buffer.html">oggpack_buffer</a> data buffer and advances the location pointer.
00021 <p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>.
00022 
00023 <br><br>
00024 <table border=0 color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026         <td>
00027 <pre><b>
00028 long  oggpack_read1(oggpack_buffer *b);
00029 </b></pre>
00030         </td>
00031 </tr>
00032 </table>
00033 
00034 <h3>Parameters</h3>
00035 <dl>
00036 <dt><i>b</i></dt>
00037 <dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd>
00038 </dl>
00039 
00040 
00041 <h3>Return Values</h3>
00042 <blockquote>
00043 <li>
00044 <i>n</i> is the bit read by this function.</li>
00045 </blockquote>
00046 <p>
00047 
00048 <br><br>
00049 <hr noshade>
00050 <table border=0 width=100%>
00051 <tr valign=top>
00052 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
00053 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00054 </tr><tr>
00055 <td><p class=tiny>libogg documentation</p></td>
00056 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00057 </tr>
00058 </table>
00059 
00060 
00061 </body>
00062 
00063 </html>

Generated by  doxygen 1.6.2