ogg/doc/libogg/ogg_stream_packetin.html

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