]> git.jsancho.org Git - lugaru.git/blob - libogg-1.0/doc/ogg/oggpack_read.html
Added (more or less) demo data files.
[lugaru.git] / libogg-1.0 / doc / ogg / oggpack_read.html
1 <html>
2
3 <head>
4 <title>libogg - function - oggpack_read</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>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
13 </tr>
14 </table>
15
16 <h1>oggpack_read</h1>
17
18 <p><i>declared in "ogg/ogg.h";</i></p>
19
20 <p>This function reads the requested number of bits from the buffer and advances the location pointer.
21 <p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>.
22
23 <br><br>
24 <table border=0 color=black cellspacing=0 cellpadding=7>
25 <tr bgcolor=#cccccc>
26         <td>
27 <pre><b>
28 long oggpack_read(oggpack_buffer *b,int bits);
29 </b></pre>
30         </td>
31 </tr>
32 </table>
33
34 <h3>Parameters</h3>
35 <dl>
36 <dt><i>b</i></dt>
37 <dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd>
38 <dt><i>bits</i></dt>
39 <dd>Number of bits to read.</dd>
40 </dl>
41
42
43 <h3>Return Values</h3>
44 <blockquote>
45 <li>
46 <i>n</i> represents the requested bits.</li>
47 </blockquote>
48 <p>
49
50 <br><br>
51 <hr noshade>
52 <table border=0 width=100%>
53 <tr valign=top>
54 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
55 <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>
56 </tr><tr>
57 <td><p class=tiny>libogg documentation</p></td>
58 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
59 </tr>
60 </table>
61
62
63 </body>
64
65 </html>