← Back to branch summary

~vorlon/ubuntu/oneiric/libogg/multiarch

« back to all changes in this revision

Viewing changes to doc/ogg/ogg_stream_pageout.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2005-12-14 16:43:15 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051214164315-9moe8pktxsl5o9yw
Tags: 1.1.3-0ubuntu1
New upstream version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/ogg/ogg_stream_pageout.html
1
 
<html>
2
 
 
3
 
<head>
4
 
<title>libogg - function - ogg_stream_pageout</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.0 - 20000615</p></td>
13
 
</tr>
14
 
</table>
15
 
 
16
 
<h1>ogg_stream_pageout</h1>
17
 
 
18
 
<p><i>declared in "ogg/ogg.h";</i></p>
19
 
 
20
 
<p>This function forms packets into pages.  If  
21
 
 <p>In a typical encoding situation, this would be called after using <a href="ogg_stream_packetin.html">ogg_stream_packetin</a> to submit data packets to the bitstream.
22
 
<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.
23
 
 
24
 
<br><br>
25
 
<table border=0 color=black cellspacing=0 cellpadding=7>
26
 
<tr bgcolor=#cccccc>
27
 
        <td>
28
 
<pre><b>
29
 
int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
30
 
</b></pre>
31
 
        </td>
32
 
</tr>
33
 
</table>
34
 
 
35
 
<h3>Parameters</h3>
36
 
<dl>
37
 
<dt><i>os</i></dt>
38
 
<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
39
 
<dt><i>og</i></dt>
40
 
<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.
41
 
</dl>
42
 
 
43
 
 
44
 
<h3>Return Values</h3>
45
 
<blockquote>
46
 
<li>Zero means that insufficient data has accumulated to fill a page.</li>
47
 
<li>Non-zero means that a page has been completed and flushed.</li>
48
 
</blockquote>
49
 
<p>
50
 
 
51
 
<br><br>
52
 
<hr noshade>
53
 
<table border=0 width=100%>
54
 
<tr valign=top>
55
 
<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
56
 
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
57
 
</tr><tr>
58
 
<td><p class=tiny>libogg documentation</p></td>
59
 
<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
60
 
</tr>
61
 
</table>
62
 
 
63
 
 
64
 
</body>
65
 
 
66
 
</html>