00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_stream_init</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_stream_init</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_stream_state</a> struct and allocates appropriate memory in preparation for encoding or decoding.
00021 <p>It also assigns the stream a given serial number.
00022 <br><br>
00023 <table border=0 color=black cellspacing=0 cellpadding=7>
00024 <tr bgcolor=#cccccc>
00025 <td>
00026 <pre><b>
00027 int ogg_stream_init(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,int serialno);
00028 </b></pre>
00029 </td>
00030 </tr>
00031 </table>
00032
00033 <h3>Parameters</h3>
00034 <dl>
00035 <dt><i>os</i></dt>
00036 <dd>Pointer to the ogg_stream_state struct that we will be initializing.</dd>
00037 <dt><i>serialno</i></dt>
00038 <dd>Serial number that we will attach to this stream.</dd>
00039 </dl>
00040
00041
00042 <h3>Return Values</h3>
00043 <blockquote>
00044 <li>
00045 0 if successful</li>
00046 <li>
00047 -1 if unsuccessful. If this fails, the ogg_stream_state was not properly declared before calling this function.</li>
00048 </blockquote>
00049 <p>
00050
00051 <br><br>
00052 <hr noshade>
00053 <table border=0 width=100%>
00054 <tr valign=top>
00055 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00056 <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>
00057 </tr><tr>
00058 <td><p class=tiny>libogg documentation</p></td>
00059 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00060 </tr>
00061 </table>
00062
00063
00064 </body>
00065
00066 </html>
