cannam@86: <html> cannam@86: cannam@86: <head> cannam@86: <title>libvorbis - function - vorbis_synthesis_headerin</title> cannam@86: <link rel=stylesheet href="style.css" type="text/css"> cannam@86: </head> cannam@86: cannam@86: <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> cannam@86: <table border=0 width=100%> cannam@86: <tr> cannam@86: <td><p class=tiny>libvorbis documentation</p></td> cannam@86: <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> cannam@86: </tr> cannam@86: </table> cannam@86: cannam@86: <h1>vorbis_synthesis_headerin</h1> cannam@86: cannam@86: <p><i>declared in "vorbis/codec.h";</i></p> cannam@86: cannam@86: <p>This function decodes a header packet from a Vorbis stream and applies cannam@86: the contents to the given <a href="vorbis_info.html">vorbis_info</a> cannam@86: structure (to provide codec parameters to the decoder) and cannam@86: <a href="vorbis_comment.html">vorbis_comment</a> structure (to provide cannam@86: access to the embedded Vorbis comments).</p> cannam@86: cannam@86: <p>Once the three Vorbis header packets (info, comments, cannam@86: and codebooks, in that order) have been passed to this cannam@86: function, the <a href="vorbis_info.html">vorbis_info</a> cannam@86: structure is ready to be used in a call to cannam@86: <a href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</p> cannam@86: cannam@86: <table border=0 color=black cellspacing=0 cellpadding=7> cannam@86: <tr bgcolor=#cccccc> cannam@86: <td> cannam@86: <pre><b> cannam@86: extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc, cannam@86: ogg_packet *op); cannam@86: </b></pre> cannam@86: </td> cannam@86: </tr> cannam@86: </table> cannam@86: cannam@86: <h3>Parameters</h3> cannam@86: <dl> cannam@86: <dt><i>vi</i></dt> cannam@86: <dd>The <a href="vorbis_info.html">vorbis_info</a> structure to apply cannam@86: the decoded information to.</dd> cannam@86: <dt><i>vc</i></dt> cannam@86: <dd>The <a href="vorbis_comment.html">vorbis_comment</a> structure to cannam@86: apply the decoded comments to.</dd> cannam@86: <dt><i>op</i></dt> cannam@86: <dd>The ogg_packet to decode.</dd> cannam@86: </dl> cannam@86: cannam@86: cannam@86: <h3>Return Values</h3> cannam@86: <blockquote> cannam@86: <li>0 on success.</li> cannam@86: <li>OV_ENOTVORBIS if the packet is not a Vorbis header packet.</li> cannam@86: <li>OV_EBADHEADER if there was an error interpreting the packet.</li> cannam@86: <li>OV_EFAULT on internal error.</li> cannam@86: </blockquote> cannam@86: <p> cannam@86: cannam@86: <br><br> cannam@86: <hr noshade> cannam@86: <table border=0 width=100%> cannam@86: <tr valign=top> cannam@86: <td><p class=tiny>copyright © 2010 Xiph.Org</p></td> cannam@86: <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> cannam@86: </tr><tr> cannam@86: <td><p class=tiny>libvorbis documentation</p></td> cannam@86: <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> cannam@86: </tr> cannam@86: </table> cannam@86: cannam@86: cannam@86: </body> cannam@86: cannam@86: </html>