diff options
| author | Aki <please@ignore.pl> | 2021-10-01 23:46:47 +0200 |
|---|---|---|
| committer | Aki <please@ignore.pl> | 2021-10-01 23:46:47 +0200 |
| commit | ddd76aa4e1571c8d5965709db5c3cd47a89c9a38 (patch) | |
| tree | 4e07bfaebede6531a70984fdebc855bca52f394a /ogg/doc/libogg/ogg_stream_pagein.html | |
| parent | 3a507e08b1d4e5970b27401a7e6517570d529400 (diff) | |
| parent | c2d2c3551501110fddd78674d5435bfaa70382a3 (diff) | |
| download | starshatter-ddd76aa4e1571c8d5965709db5c3cd47a89c9a38.zip starshatter-ddd76aa4e1571c8d5965709db5c3cd47a89c9a38.tar.gz starshatter-ddd76aa4e1571c8d5965709db5c3cd47a89c9a38.tar.bz2 | |
Project is now built with CMake
Diffstat (limited to 'ogg/doc/libogg/ogg_stream_pagein.html')
| -rw-r--r-- | ogg/doc/libogg/ogg_stream_pagein.html | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/ogg/doc/libogg/ogg_stream_pagein.html b/ogg/doc/libogg/ogg_stream_pagein.html new file mode 100644 index 0000000..fddaed1 --- /dev/null +++ b/ogg/doc/libogg/ogg_stream_pagein.html @@ -0,0 +1,67 @@ +<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 occurred.</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 © 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> |