ogg_stream_packetin.html 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <html>
  2. <head>
  3. <title>libogg - function - ogg_stream_packetin</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_stream_packetin</h1>
  14. <p><i>declared in "ogg/ogg.h";</i></p>
  15. <p>This function submits a packet to the bitstream for page
  16. encapsulation. After this is called, more packets can be submitted,
  17. or pages can be written out.</p>
  18. <p>In a typical encoding situation, this should be used after filling a
  19. packet with data.
  20. The data in the packet is copied into the internal storage managed by
  21. the <a href="ogg_stream_state.html">ogg_stream_state</a>, so the caller
  22. is free to alter the contents of <i>op</i> after this call has returned.
  23. <br><br>
  24. <table border=0 color=black cellspacing=0 cellpadding=7>
  25. <tr bgcolor=#cccccc>
  26. <td>
  27. <pre><b>
  28. int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
  29. </b></pre>
  30. </td>
  31. </tr>
  32. </table>
  33. <h3>Parameters</h3>
  34. <dl>
  35. <dt><i>os</i></dt>
  36. <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd>
  37. <dt><i>op</i></dt>
  38. <dd>Pointer to the packet we are putting into the bitstream.
  39. </dl>
  40. <h3>Return Values</h3>
  41. <blockquote>
  42. <li>
  43. 0 returned on success. -1 returned in the event of internal error.</li>
  44. </blockquote>
  45. <p>
  46. <br><br>
  47. <hr noshade>
  48. <table border=0 width=100%>
  49. <tr valign=top>
  50. <td><p class=tiny>copyright &copy; 2000-2019 Xiph.Org Foundation</p></td>
  51. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  52. </tr><tr>
  53. <td><p class=tiny>libogg documentation</p></td>
  54. <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td>
  55. </tr>
  56. </table>
  57. </body>
  58. </html>