cog/Frameworks/Ogg/doc/libogg/ogg_stream_packetin.html

73 lines
1.8 KiB
HTML
Raw Normal View History

2006-04-17 13:06:32 +00:00
<html>
<head>
<title>libogg - function - ogg_stream_packetin</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>
2006-04-17 13:06:32 +00:00
</tr>
</table>
<h1>ogg_stream_packetin</h1>
<p><i>declared in "ogg/ogg.h";</i></p>
<p>This function submits a packet to the bitstream for page
encapsulation. After this is called, more packets can be submitted,
or pages can be written out.</p>
<p>In a typical encoding situation, this should be used after filling a
packet with data.
The data in the packet is copied into the internal storage managed by
the <a href="ogg_stream_state.html">ogg_stream_state</a>, so the caller
is free to alter the contents of <i>op</i> after this call has returned.
2006-04-17 13:06:32 +00:00
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
</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.</dd>
<dt><i>op</i></dt>
<dd>Pointer to the packet we are putting into the bitstream.
</dl>
<h3>Return Values</h3>
<blockquote>
<li>
0 returned on success. -1 returned in the event of internal error.</li>
2006-04-17 13:06:32 +00:00
</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>
2006-04-17 13:06:32 +00:00
</tr><tr>
<td><p class=tiny>libogg documentation</p></td>
<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
2006-04-17 13:06:32 +00:00
</tr>
</table>
</body>
</html>