ogg_page_packets.html 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <html>
  2. <head>
  3. <title>libogg - function - ogg_page_packets</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.3.4 - 20190830</p></td>
  11. </tr>
  12. </table>
  13. <h1>ogg_page_packets</h1>
  14. <p><i>declared in "ogg/ogg.h";</i></p>
  15. <p>Returns the number of packets that are completed on this page. If the
  16. leading packet is begun on a previous page, but ends on this page, it's
  17. counted.
  18. <p>
  19. <br><br>
  20. <table border=0 color=black cellspacing=0 cellpadding=7>
  21. <tr bgcolor=#cccccc>
  22. <td>
  23. <pre><b>
  24. int ogg_page_packets(ogg_page *og);
  25. </b></pre>
  26. </td>
  27. </tr>
  28. </table>
  29. <h3>Parameters</h3>
  30. <dl>
  31. <dt><i>og</i></dt>
  32. <dd>Pointer to the current ogg_page struct.</dd>
  33. </dl>
  34. <h3>Return Values</h3>
  35. <blockquote>
  36. If a page consists of a packet begun on a previous page, and a new packet
  37. begun (but not completed) on this page, the return will be:<br>
  38. <br>
  39. ogg_page_packets(page) will return 1,<br>
  40. ogg_page_continued(paged) will return non-zero.<br>
  41. <br><br>
  42. If a page happens to be a single packet that was begun on a previous page, and
  43. spans to the next page (in the case of a three or more page packet), the
  44. return will be:<br>
  45. <br>
  46. ogg_page_packets(page) will return 0,<br>
  47. ogg_page_continued(page) will return non-zero.<br>
  48. </blockquote>
  49. <p>
  50. <br><br>
  51. <hr noshade>
  52. <table border=0 width=100%>
  53. <tr valign=top>
  54. <td><p class=tiny>copyright &copy; 2000-2019 Xiph.Org Foundation</p></td>
  55. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  56. </tr><tr>
  57. <td><p class=tiny>libogg documentation</p></td>
  58. <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td>
  59. </tr>
  60. </table>
  61. </body>
  62. </html>