libogg-1.0/doc/ogg/ogg_sync_init.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - ogg_sync_init</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>libogg documentation</p></td>
  12 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ogg_sync_init</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_sync_state</a> struct to a known initial value in preparation for manipulation of an Ogg bitstream.
  21 <p>The ogg_sync struct is important when decoding, as it synchronizes retrieval and return of data.
  22
  23 <br><br>
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  28 int ogg_sync_init(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>oy</i></dt>
  37 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.  After this function call, this struct has been initialized.</dd>
  38 </dl>
  39
  40
  41 <h3>Return Values</h3>
  42 <blockquote>
  43 <li>
  44 0 is always returned.</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; 2000 xiph.org</p></td>
  53 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
  54 </tr><tr>
  55 <td><p class=tiny>libogg documentation</p></td>
  56 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  57 </tr>
  58 </table>
  59
  60
  61 </body>
  62
  63 </html>