Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/ogg_stream_pagein.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_pagein</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_pagein</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 adds a complete page to the bitstream. |
| cannam@86 | 21 <p>In a typical decoding situation, this function would be called after using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <a href="ogg_page.html">ogg_page</a> struct. |
| cannam@86 | 22 <p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. |
| cannam@86 | 23 |
| cannam@86 | 24 <br><br> |
| cannam@86 | 25 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 26 <tr bgcolor=#cccccc> |
| cannam@86 | 27 <td> |
| cannam@86 | 28 <pre><b> |
| cannam@86 | 29 int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); |
| cannam@86 | 30 </b></pre> |
| cannam@86 | 31 </td> |
| cannam@86 | 32 </tr> |
| cannam@86 | 33 </table> |
| cannam@86 | 34 |
| cannam@86 | 35 <h3>Parameters</h3> |
| cannam@86 | 36 <dl> |
| cannam@86 | 37 <dt><i>os</i></dt> |
| cannam@86 | 38 <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd> |
| cannam@86 | 39 <dt><i>og</i></dt> |
| cannam@86 | 40 <dd>Pointer to a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets. |
| cannam@86 | 41 </dl> |
| cannam@86 | 42 |
| cannam@86 | 43 |
| cannam@86 | 44 <h3>Return Values</h3> |
| cannam@86 | 45 <blockquote> |
| cannam@86 | 46 <li>-1 indicates failure. This means that the serial number of the page did not match the serial number of the bitstream, the page version was incorrect, or an internal error accurred.</li> |
| cannam@86 | 47 <li> |
| cannam@86 | 48 0 means that the page was successfully submitted to the bitstream.</li> |
| cannam@86 | 49 </blockquote> |
| cannam@86 | 50 <p> |
| cannam@86 | 51 |
| cannam@86 | 52 <br><br> |
| cannam@86 | 53 <hr noshade> |
| cannam@86 | 54 <table border=0 width=100%> |
| cannam@86 | 55 <tr valign=top> |
| cannam@86 | 56 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> |
| cannam@86 | 57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| cannam@86 | 58 </tr><tr> |
| cannam@86 | 59 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 60 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 61 </tr> |
| cannam@86 | 62 </table> |
| cannam@86 | 63 |
| cannam@86 | 64 |
| cannam@86 | 65 </body> |
| cannam@86 | 66 |
| cannam@86 | 67 </html> |