|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libvorbis - function - vorbis_synthesis_headerin</title>
|
|
cannam@86
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
cannam@86
|
6 </head>
|
|
cannam@86
|
7
|
|
cannam@86
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
cannam@86
|
9 <table border=0 width=100%>
|
|
cannam@86
|
10 <tr>
|
|
cannam@86
|
11 <td><p class=tiny>libvorbis documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>vorbis_synthesis_headerin</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "vorbis/codec.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function decodes a header packet from a Vorbis stream and applies
|
|
cannam@86
|
21 the contents to the given <a href="vorbis_info.html">vorbis_info</a>
|
|
cannam@86
|
22 structure (to provide codec parameters to the decoder) and
|
|
cannam@86
|
23 <a href="vorbis_comment.html">vorbis_comment</a> structure (to provide
|
|
cannam@86
|
24 access to the embedded Vorbis comments).</p>
|
|
cannam@86
|
25
|
|
cannam@86
|
26 <p>Once the three Vorbis header packets (info, comments,
|
|
cannam@86
|
27 and codebooks, in that order) have been passed to this
|
|
cannam@86
|
28 function, the <a href="vorbis_info.html">vorbis_info</a>
|
|
cannam@86
|
29 structure is ready to be used in a call to
|
|
cannam@86
|
30 <a href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</p>
|
|
cannam@86
|
31
|
|
cannam@86
|
32 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
33 <tr bgcolor=#cccccc>
|
|
cannam@86
|
34 <td>
|
|
cannam@86
|
35 <pre><b>
|
|
cannam@86
|
36 extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
|
|
cannam@86
|
37 ogg_packet *op);
|
|
cannam@86
|
38 </b></pre>
|
|
cannam@86
|
39 </td>
|
|
cannam@86
|
40 </tr>
|
|
cannam@86
|
41 </table>
|
|
cannam@86
|
42
|
|
cannam@86
|
43 <h3>Parameters</h3>
|
|
cannam@86
|
44 <dl>
|
|
cannam@86
|
45 <dt><i>vi</i></dt>
|
|
cannam@86
|
46 <dd>The <a href="vorbis_info.html">vorbis_info</a> structure to apply
|
|
cannam@86
|
47 the decoded information to.</dd>
|
|
cannam@86
|
48 <dt><i>vc</i></dt>
|
|
cannam@86
|
49 <dd>The <a href="vorbis_comment.html">vorbis_comment</a> structure to
|
|
cannam@86
|
50 apply the decoded comments to.</dd>
|
|
cannam@86
|
51 <dt><i>op</i></dt>
|
|
cannam@86
|
52 <dd>The ogg_packet to decode.</dd>
|
|
cannam@86
|
53 </dl>
|
|
cannam@86
|
54
|
|
cannam@86
|
55
|
|
cannam@86
|
56 <h3>Return Values</h3>
|
|
cannam@86
|
57 <blockquote>
|
|
cannam@86
|
58 <li>0 on success.</li>
|
|
cannam@86
|
59 <li>OV_ENOTVORBIS if the packet is not a Vorbis header packet.</li>
|
|
cannam@86
|
60 <li>OV_EBADHEADER if there was an error interpreting the packet.</li>
|
|
cannam@86
|
61 <li>OV_EFAULT on internal error.</li>
|
|
cannam@86
|
62 </blockquote>
|
|
cannam@86
|
63 <p>
|
|
cannam@86
|
64
|
|
cannam@86
|
65 <br><br>
|
|
cannam@86
|
66 <hr noshade>
|
|
cannam@86
|
67 <table border=0 width=100%>
|
|
cannam@86
|
68 <tr valign=top>
|
|
cannam@86
|
69 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td>
|
|
cannam@86
|
70 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
|
|
cannam@86
|
71 </tr><tr>
|
|
cannam@86
|
72 <td><p class=tiny>libvorbis documentation</p></td>
|
|
cannam@86
|
73 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
74 </tr>
|
|
cannam@86
|
75 </table>
|
|
cannam@86
|
76
|
|
cannam@86
|
77
|
|
cannam@86
|
78 </body>
|
|
cannam@86
|
79
|
|
cannam@86
|
80 </html>
|
