Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/ogg_stream_init.html @ 36:55ece8862b6d
Merge
| author | Chris Cannam |
|---|---|
| date | Wed, 11 Mar 2015 13:32:44 +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_stream_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_stream_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_stream_state</a> struct and allocates appropriate memory in preparation for encoding or decoding. |
| Chris@1 | 21 <p>It also assigns the stream a given serial number. |
| Chris@1 | 22 <br><br> |
| Chris@1 | 23 <table border=0 color=black cellspacing=0 cellpadding=7> |
| Chris@1 | 24 <tr bgcolor=#cccccc> |
| Chris@1 | 25 <td> |
| Chris@1 | 26 <pre><b> |
| Chris@1 | 27 int ogg_stream_init(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,int serialno); |
| Chris@1 | 28 </b></pre> |
| Chris@1 | 29 </td> |
| Chris@1 | 30 </tr> |
| Chris@1 | 31 </table> |
| Chris@1 | 32 |
| Chris@1 | 33 <h3>Parameters</h3> |
| Chris@1 | 34 <dl> |
| Chris@1 | 35 <dt><i>os</i></dt> |
| Chris@1 | 36 <dd>Pointer to the ogg_stream_state struct that we will be initializing.</dd> |
| Chris@1 | 37 <dt><i>serialno</i></dt> |
| Chris@1 | 38 <dd>Serial number that we will attach to this stream.</dd> |
| Chris@1 | 39 </dl> |
| Chris@1 | 40 |
| Chris@1 | 41 |
| Chris@1 | 42 <h3>Return Values</h3> |
| Chris@1 | 43 <blockquote> |
| Chris@1 | 44 <li> |
| Chris@1 | 45 0 if successful</li> |
| Chris@1 | 46 <li> |
| Chris@1 | 47 -1 if unsuccessful.</li> |
| Chris@1 | 48 </blockquote> |
| Chris@1 | 49 <p> |
| Chris@1 | 50 |
| Chris@1 | 51 <br><br> |
| Chris@1 | 52 <hr noshade> |
| Chris@1 | 53 <table border=0 width=100%> |
| Chris@1 | 54 <tr valign=top> |
| Chris@1 | 55 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> |
| Chris@1 | 56 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| Chris@1 | 57 </tr><tr> |
| Chris@1 | 58 <td><p class=tiny>libogg documentation</p></td> |
| Chris@1 | 59 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| Chris@1 | 60 </tr> |
| Chris@1 | 61 </table> |
| Chris@1 | 62 |
| Chris@1 | 63 |
| Chris@1 | 64 </body> |
| Chris@1 | 65 |
| Chris@1 | 66 </html> |