ogg_stream_pagein.html 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <html>
  2. <head>
  3. <title>libogg - function - ogg_stream_pagein</title>
  4. <link rel=stylesheet href="style.css" type="text/css">
  5. </head>
  6. <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  7. <table border=0 width=100%>
  8. <tr>
  9. <td><p class=tiny>libogg documentation</p></td>
  10. <td align=right><p class=tiny>libogg release 1.2.1 - 20101029</p></td>
  11. </tr>
  12. </table>
  13. <h1>ogg_stream_pagein</h1>
  14. <p><i>declared in "ogg/ogg.h";</i></p>
  15. <p>This function adds a complete page to the bitstream.
  16. <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.
  17. <p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.
  18. <br><br>
  19. <table border=0 color=black cellspacing=0 cellpadding=7>
  20. <tr bgcolor=#cccccc>
  21. <td>
  22. <pre><b>
  23. int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
  24. </b></pre>
  25. </td>
  26. </tr>
  27. </table>
  28. <h3>Parameters</h3>
  29. <dl>
  30. <dt><i>os</i></dt>
  31. <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
  32. <dt><i>og</i></dt>
  33. <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.
  34. </dl>
  35. <h3>Return Values</h3>
  36. <blockquote>
  37. <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>
  38. <li>
  39. 0 means that the page was successfully submitted to the bitstream.</li>
  40. </blockquote>
  41. <p>
  42. <br><br>
  43. <hr noshade>
  44. <table border=0 width=100%>
  45. <tr valign=top>
  46. <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
  47. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  48. </tr><tr>
  49. <td><p class=tiny>libogg documentation</p></td>
  50. <td align=right><p class=tiny>libogg release 1.2.1 - 20101029</p></td>
  51. </tr>
  52. </table>
  53. </body>
  54. </html>