diff options
Diffstat (limited to 'doc/ogg/ogg_stream_pagein.html')
-rw-r--r-- | doc/ogg/ogg_stream_pagein.html | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/ogg/ogg_stream_pagein.html b/doc/ogg/ogg_stream_pagein.html index 81ce5db..fc5f9f4 100644 --- a/doc/ogg/ogg_stream_pagein.html +++ b/doc/ogg/ogg_stream_pagein.html @@ -17,8 +17,8 @@ <p><i>declared in "ogg/ogg.h";</i></p> -<p>This function adds a complete page to the bitstream.
- <p>In a typical decoding situation, this function would be called after using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <a href="ogg_page.html">ogg_page</a> struct.
+<p>This function adds a complete page to the bitstream. + <p>In a typical decoding situation, this function would be called after using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <a href="ogg_page.html">ogg_page</a> struct. <p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer. <br><br> @@ -35,15 +35,15 @@ int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <h3>Parameters</h3> <dl> <dt><i>os</i></dt> -<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
-<dt><i>og</i></dt>
+<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd> +<dt><i>og</i></dt> <dd>Pointer to a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets. </dl> <h3>Return Values</h3> <blockquote> -<li>-1 indicates failure. This means that the serial number of the page did not match the serial number of the bitstream, or that the page version was incorrect.</li>
+<li>-1 indicates failure. This means that the serial number of the page did not match the serial number of the bitstream, or that the page version was incorrect.</li> <li> 0 means that the page was successfully submitted to the bitstream.</li> </blockquote> |