diff options
Diffstat (limited to 'ogg/doc/libogg/ogg_page_packets.html')
-rw-r--r-- | ogg/doc/libogg/ogg_page_packets.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/ogg/doc/libogg/ogg_page_packets.html b/ogg/doc/libogg/ogg_page_packets.html new file mode 100644 index 0000000..0115777 --- /dev/null +++ b/ogg/doc/libogg/ogg_page_packets.html @@ -0,0 +1,75 @@ +<html> + +<head> +<title>libogg - function - ogg_page_packets</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_page_packets</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the number of packets that are completed on this page. If the +leading packet is begun on a previous page, but ends on this page, it's +counted. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_packets(ogg_page *og); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +If a page consists of a packet begun on a previous page, and a new packet +begun (but not completed) on this page, the return will be:<br> +<br> +ogg_page_packets(page) will return 1,<br> +ogg_page_continued(paged) will return non-zero.<br> +<br><br> +If a page happens to be a single packet that was begun on a previous page, and +spans to the next page (in the case of a three or more page packet), the +return will be:<br> +<br> +ogg_page_packets(page) will return 0,<br> +ogg_page_continued(page) will return non-zero.<br> +</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> |