doc/libvorbis/vorbis_synthesis_idheader.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis_idheader</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_idheader</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function checks whether a packet is a valid Vorbis identification
  21 header packet. This function can be used to detect whether a logical
  22 Ogg stream could be a Vorbis stream, given its very first packet.</p>
  23
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  28 extern int      vorbis_synthesis_idheader(ogg_packet *op);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>op</i></dt>
  37 <dd>Pointer to the ogg_packet to check.</dd>
  38 </dl>
  39
  40
  41 <h3>Return Values</h3>
  42 <blockquote>
  43 <li>1 if the packet is a valid first packet for a Vorbis bitstream.</li>
  44 <li>0 if not.</li>
  45 </blockquote>
  46 <p>
  47
  48 <br><br>
  49 <hr noshade>
  50 <table border=0 width=100%>
  51 <tr valign=top>
  52 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  53 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  54 </tr><tr>
  55 <td><p class=tiny>libvorbis documentation</p></td>
  56 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  57 </tr>
  58 </table>
  59
  60
  61 </body>
  62
  63 </html>