Add new API documenation files from the 1.3.2 release.
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_synthesis_trackonly.html
1 <html>
2
3 <head>
4 <title>libvorbis - function - vorbis_synthesis_trackonly</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_synthesis_trackonly</h1>
17
18 <p><i>declared in "vorbis/codec.h";</i></p>
19
20 <p>This function decodes a Vorbis packet similarly to
21 <a href="vorbis_synthesis.html">vorbis_synthesis</a>, except that the
22 <a href="vorbis_block.html">vorbis_block</a> produced does not contain
23 any audio data but merely updates the decoder's state as though the
24 block had been actually decoded when
25 <a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a>
26 is called on it.</p>
27
28 <table border=0 color=black cellspacing=0 cellpadding=7>
29 <tr bgcolor=#cccccc>
30         <td>
31 <pre><b>
32 extern int      vorbis_synthesis_trackonly(vorbis_block *vb,ogg_packet *op);
33 </b></pre>
34         </td>
35 </tr>
36 </table>
37
38 <h3>Parameters</h3>
39 <dl>
40 <dt><i>vb</i></dt>
41 <dd>The <a href="vorbis_block.html">vorbis_block</a> to decode the
42 packet into.</dd>
43 <dt><i>op</i></dt>
44 <dd>The ogg_packet to decode.</dd>
45 </dl>
46
47
48 <h3>Return Values</h3>
49 <blockquote>
50 <li>0 on success.</li>
51 <li>OV_ENOTAUDIO if the packet is not an audio packet.</li>
52 <li>OV_EBADPACKET if there was an error in the packet.</li>
53 </blockquote>
54 <p>
55
56 <br><br>
57 <hr noshade>
58 <table border=0 width=100%>
59 <tr valign=top>
60 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
62 </tr><tr>
63 <td><p class=tiny>libvorbis documentation</p></td>
64 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
65 </tr>
66 </table>
67
68
69 </body>
70
71 </html>