etlegacy-libs/ogg/doc/libogg/ogg_stream_pagein.html

<html>

<head>
<title>libogg - function - ogg_stream_pagein</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libogg documentation</p></td>
<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
</tr>
</table>

<h1>ogg_stream_pagein</h1>

<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>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.

<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
</b></pre>
	</td>
</tr>
</table>

<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, 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, the page version was incorrect, or an internal error accurred.</li>
<li>
0 means that the page was successfully submitted to the bitstream.</li>
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2000-2014 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
</tr><tr>
<td><p class=tiny>libogg documentation</p></td>
<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
</tr>
</table>


</body>

</html>
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`<html>`

			`<head>`
			`<title>libogg - function - ogg_stream_pagein</title>`
			`<link rel=stylesheet href="style.css" type="text/css">`
			`</head>`

			`<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">`
			`<table border=0 width=100%>`
			`<tr>`
			`<td><p class=tiny>libogg documentation</p></td>`
updated to libogg 1.3.2 2015-01-24 19:23:54 +00:00			`<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>`
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`</tr>`
			`</table>`

			`<h1>ogg_stream_pagein</h1>`

			`<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>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.`

			`<br><br>`
			`<table border=0 color=black cellspacing=0 cellpadding=7>`
			`<tr bgcolor=#cccccc>`
			`<td>`
			`<pre><b>`
			`int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> os, <a href="ogg_page.html">ogg_page</a> og);`
			`</b></pre>`
			`</td>`
			`</tr>`
			`</table>`

			`<h3>Parameters</h3>`
			`<dl>`
			`<dt><i>os</i></dt>`
updated to libogg 1.3.2 2015-01-24 19:23:54 +00:00			`<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd>`
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`<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, the page version was incorrect, or an internal error accurred.</li>`
			`<li>`
			`0 means that the page was successfully submitted to the bitstream.</li>`
			`</blockquote>`
			`<p>`

			`<br><br>`
			`<hr noshade>`
			`<table border=0 width=100%>`
			`<tr valign=top>`
updated to libogg 1.3.2 2015-01-24 19:23:54 +00:00			`<td><p class=tiny>copyright © 2000-2014 Xiph.Org</p></td>`
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>`
			`</tr><tr>`
			`<td><p class=tiny>libogg documentation</p></td>`
updated to libogg 1.3.2 2015-01-24 19:23:54 +00:00			`<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>`
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`</tr>`
			`</table>`


			`</body>`

			`</html>`