summaryrefslogtreecommitdiffhomepage
path: root/doc/libvorbis/vorbis_packet_blocksize.html
blob: 827e03f87d90fd8870e7d87fa8460c3d1912209b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<html>

<head>
<title>libvorbis - function - vorbis_packet_blocksize</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>vorbis_packet_blocksize</h1>

<p><i>declared in "vorbis/codec.h";</i></p>

<p>This function gets the size of the block that would result from
decoding a Vorbis packet but does not actually decode the packet.</p>

<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
extern long     vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
<dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the
stream the packet is from.</dd>
<dt><i>op</i></dt>
<dd>The packet to get the block size of.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<li>The block size on success.</li>
<li>OV_ENOTAUDIO if the packet is not an audio packet.</li>
<li>OV_EBADPACKET if there was an error in the packet.</li>
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>


</body>

</html>