annotate src/libogg-1.3.0/doc/libogg/ogg_sync_init.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 05aa0afa9217
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libogg - function - ogg_sync_init</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>libogg documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>ogg_sync_init</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "ogg/ogg.h";</i></p>
Chris@1 19
Chris@1 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.
Chris@1 21 <p>The ogg_sync struct is important when decoding, as it synchronizes retrieval and return of data.
Chris@1 22
Chris@1 23 <br><br>
Chris@1 24 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 25 <tr bgcolor=#cccccc>
Chris@1 26 <td>
Chris@1 27 <pre><b>
Chris@1 28 int ogg_sync_init(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
Chris@1 29 </b></pre>
Chris@1 30 </td>
Chris@1 31 </tr>
Chris@1 32 </table>
Chris@1 33
Chris@1 34 <h3>Parameters</h3>
Chris@1 35 <dl>
Chris@1 36 <dt><i>oy</i></dt>
Chris@1 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>
Chris@1 38 </dl>
Chris@1 39
Chris@1 40
Chris@1 41 <h3>Return Values</h3>
Chris@1 42 <blockquote>
Chris@1 43 <li>
Chris@1 44 0 is always returned.</li>
Chris@1 45 </blockquote>
Chris@1 46 <p>
Chris@1 47
Chris@1 48 <br><br>
Chris@1 49 <hr noshade>
Chris@1 50 <table border=0 width=100%>
Chris@1 51 <tr valign=top>
Chris@1 52 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
Chris@1 53 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
Chris@1 54 </tr><tr>
Chris@1 55 <td><p class=tiny>libogg documentation</p></td>
Chris@1 56 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 57 </tr>
Chris@1 58 </table>
Chris@1 59
Chris@1 60
Chris@1 61 </body>
Chris@1 62
Chris@1 63 </html>