Add new API documenation files from the 1.3.2 release.
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_block.html
1 <html>
2
3 <head>
4 <title>libvorbis - datatype - vorbis_block</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>libvorbis documentation</p></td>
12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
13 </tr>
14 </table>
15
16 <h1>vorbis_block</h1>
17
18 <p><i>declared in "vorbis/codec.h"</i></p>
19
20 <p>
21 The vorbis_block structure holds the data for a single block of audio. One
22 vorbis_block translates to one codec packet. The encoding process consists
23 of splitting the audio into blocks and encoding the blocks into packets;
24 decoding consists of decoding the packets into blocks and reassembling
25 the audio from the blocks.
26 <p>
27 This structure is intended to be private. Although the fields are given
28 in the header file, they should not be directly modified or relied upon
29 in any way.
30 <p>
31
32 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
33 <tr bgcolor=#cccccc>
34         <td>
35 <pre><b>typedef struct vorbis_block{
36   /* private */
37 } vorbis_block;</b></pre>
38         </td>
39 </tr>
40 </table>
41
42 <h3>Parameters</h3>
43 <ul><li>None public.</li></ul>
44
45
46 <br><br>
47 <hr noshade>
48 <table border=0 width=100%>
49 <tr valign=top>
50 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
51 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
52 </tr><tr>
53 <td><p class=tiny>libvorbis documentation</p></td>
54 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
55 </tr>
56 </table>
57
58 </body>
59
60 </html>