diff options
Diffstat (limited to 'doc/ogg/ogg_stream_packetin.html')
| -rw-r--r-- | doc/ogg/ogg_stream_packetin.html | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/ogg/ogg_stream_packetin.html b/doc/ogg/ogg_stream_packetin.html index 55f5f65..d1655ff 100644 --- a/doc/ogg/ogg_stream_packetin.html +++ b/doc/ogg/ogg_stream_packetin.html @@ -17,7 +17,7 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function takes a packet and submits it to the bitstream. After this is called, we can continue submitting packets, or we can write out pages.
+<p>This function takes a packet and submits it to the bitstream. After this is called, we can continue submitting packets, or we can write out pages. <p>In a typical decoding situation, this should be used after filling a packet with data <br><br> @@ -25,7 +25,7 @@ <tr bgcolor=#cccccc> <td> <pre><b> -int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
+int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op); </b></pre> </td> </tr> @@ -34,14 +34,14 @@ int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op); <h3>Parameters</h3> <dl> <dt><i>os</i></dt> -<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd>
-<dt><i>op</i></dt>
+<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd> +<dt><i>op</i></dt> <dd>Pointer to the packet we are putting into the bitstream. </dl> <h3>Return Values</h3> -<blockquote>
+<blockquote> <li> 0 is always returned.</li> </blockquote> |