ogg_stream_iovecin.html 2.4 KB

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