827e03f87d90fd8870e7d87fa8460c3d1912209b
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_packet_blocksize.html
1 <html>
2
3 <head>
4 <title>libvorbis - function - vorbis_packet_blocksize</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_packet_blocksize</h1>
17
18 <p><i>declared in "vorbis/codec.h";</i></p>
19
20 <p>This function gets the size of the block that would result from
21 decoding a Vorbis packet but does not actually decode the packet.</p>
22
23 <table border=0 color=black cellspacing=0 cellpadding=7>
24 <tr bgcolor=#cccccc>
25         <td>
26 <pre><b>
27 extern long     vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op);
28 </b></pre>
29         </td>
30 </tr>
31 </table>
32
33 <h3>Parameters</h3>
34 <dl>
35 <dt><i>vi</i></dt>
36 <dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the
37 stream the packet is from.</dd>
38 <dt><i>op</i></dt>
39 <dd>The packet to get the block size of.</dd>
40 </dl>
41
42
43 <h3>Return Values</h3>
44 <blockquote>
45 <li>The block size on success.</li>
46 <li>OV_ENOTAUDIO if the packet is not an audio packet.</li>
47 <li>OV_EBADPACKET if there was an error in the packet.</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="http://www.xiph.org/ogg/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>