fdcb7841590bb2650324032eea8ccc2fc23fd13e
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_block_init.html
1 <html>
2
3 <head>
4 <title>libvorbis - function - vorbis_block_init</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_init</h1>
17
18 <p><i>declared in "vorbis/codec.h";</i></p>
19
20 <p>This function initializes a vorbis_block structure and allocates its
21 internal storage. A vorbis_block is used to represent a particular block
22 of input audio which can be analyzed and coded as a unit.
23 </p>
24
25 <table border=0 color=black cellspacing=0 cellpadding=7>
26 <tr bgcolor=#cccccc>
27         <td>
28 <pre><b>
29 extern int      vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb);
30 </b></pre>
31         </td>
32 </tr>
33 </table>
34
35 <h3>Parameters</h3>
36 <dl>
37 <dt><i>v</i</dt>
38 <dd>Pointer to an initialized vorbis_dsp_state with which to associate the new block.</dd>
39 <dt><i>vb</i></dt>
40 <dd>Pointer to a vorbis_block struct to be initialized.</dd>
41 </dl>
42
43
44 <h3>Return Values</h3>
45 <blockquote>
46 <li>
47 0 for success</li>
48 </blockquote>
49 <p>
50
51 <br><br>
52 <hr noshade>
53 <table border=0 width=100%>
54 <tr valign=top>
55 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
56 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/index.html">Ogg Vorbis</a></p></td>
57 </tr><tr>
58 <td><p class=tiny>libvorbis documentation</p></td>
59 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
60 </tr>
61 </table>
62
63
64 </body>
65
66 </html>