Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/ogg_stream_destroy.html @ 86:98c1576536ae
Bring in flac, ogg, vorbis
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
| rev | line source |
|---|---|
| cannam@86 | 1 <html> |
| cannam@86 | 2 |
| cannam@86 | 3 <head> |
| cannam@86 | 4 <title>libogg - function - ogg_stream_destroy</title> |
| cannam@86 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| cannam@86 | 6 </head> |
| cannam@86 | 7 |
| cannam@86 | 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| cannam@86 | 9 <table border=0 width=100%> |
| cannam@86 | 10 <tr> |
| cannam@86 | 11 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 13 </tr> |
| cannam@86 | 14 </table> |
| cannam@86 | 15 |
| cannam@86 | 16 <h1>ogg_stream_destroy</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "ogg/ogg.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 20 <p>This function frees the internal memory used by |
| cannam@86 | 21 the <a href="ogg_stream_state.html">ogg_stream_state</a> struct as |
| cannam@86 | 22 well as the structure itself. |
| cannam@86 | 23 |
| cannam@86 | 24 <p>This should be called when you are done working with an ogg stream. |
| cannam@86 | 25 It can also be called to make sure that the struct does not exist.</p> |
| cannam@86 | 26 |
| cannam@86 | 27 <p>It calls free() on its argument, so if the ogg_stream_state |
| cannam@86 | 28 is not malloc()'d or will otherwise be freed by your own code, use |
| cannam@86 | 29 <a href="ogg_stream_clear.html">ogg_stream_clear</a> instead.</p> |
| cannam@86 | 30 |
| cannam@86 | 31 <br><br> |
| cannam@86 | 32 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 33 <tr bgcolor=#cccccc> |
| cannam@86 | 34 <td> |
| cannam@86 | 35 <pre><b> |
| cannam@86 | 36 int ogg_stream_destroy(ogg_stream_state *os); |
| cannam@86 | 37 </b></pre> |
| cannam@86 | 38 </td> |
| cannam@86 | 39 </tr> |
| cannam@86 | 40 </table> |
| cannam@86 | 41 |
| cannam@86 | 42 <h3>Parameters</h3> |
| cannam@86 | 43 <dl> |
| cannam@86 | 44 <dt><i>os</i></dt> |
| cannam@86 | 45 <dd>Pointer to the ogg_stream_state struct to be destroyed.</dd> |
| cannam@86 | 46 </dl> |
| cannam@86 | 47 |
| cannam@86 | 48 |
| cannam@86 | 49 <h3>Return Values</h3> |
| cannam@86 | 50 <blockquote> |
| cannam@86 | 51 <li> |
| cannam@86 | 52 0 is always returned.</li> |
| cannam@86 | 53 </blockquote> |
| cannam@86 | 54 <p> |
| cannam@86 | 55 |
| cannam@86 | 56 <br><br> |
| cannam@86 | 57 <hr noshade> |
| cannam@86 | 58 <table border=0 width=100%> |
| cannam@86 | 59 <tr valign=top> |
| cannam@86 | 60 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> |
| cannam@86 | 61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| cannam@86 | 62 </tr><tr> |
| cannam@86 | 63 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 64 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 65 </tr> |
| cannam@86 | 66 </table> |
| cannam@86 | 67 |
| cannam@86 | 68 |
| cannam@86 | 69 </body> |
| cannam@86 | 70 |
| cannam@86 | 71 </html> |