• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2
3<head>
4<title>libogg - function - ogg_page_packets</title>
5<link rel=stylesheet href="style.css" type="text/css">
6</head>
7
8<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9<table border=0 width=100%>
10<tr>
11<td><p class=tiny>libogg documentation</p></td>
12<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
13</tr>
14</table>
15
16<h1>ogg_page_packets</h1>
17
18<p><i>declared in "ogg/ogg.h";</i></p>
19
20<p>Returns the number of packets that are completed on this page.  If the
21leading packet is begun on a previous page, but ends on this page, it's
22counted.
23<p>
24<br><br>
25<table border=0 color=black cellspacing=0 cellpadding=7>
26<tr bgcolor=#cccccc>
27	<td>
28<pre><b>
29int ogg_page_packets(ogg_page *og);
30
31</b></pre>
32	</td>
33</tr>
34</table>
35
36<h3>Parameters</h3>
37<dl>
38<dt><i>og</i></dt>
39<dd>Pointer to the current ogg_page struct.</dd>
40</dl>
41
42
43<h3>Return Values</h3>
44<blockquote>
45If a page consists of a packet begun on a previous page, and a new packet
46begun (but not completed) on this page, the return will be:<br>
47<br>
48ogg_page_packets(page) will return 1,<br>
49ogg_page_continued(paged) will return non-zero.<br>
50<br><br>
51If a page happens to be a single packet that was begun on a previous page, and
52spans to the next page (in the case of a three or more page packet), the
53return will be:<br>
54<br>
55ogg_page_packets(page) will return 0,<br>
56ogg_page_continued(page) will return non-zero.<br>
57</blockquote>
58<p>
59
60<br><br>
61<hr noshade>
62<table border=0 width=100%>
63<tr valign=top>
64<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
65<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
66</tr><tr>
67<td><p class=tiny>libogg documentation</p></td>
68<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
69</tr>
70</table>
71
72
73</body>
74
75</html>
76