Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/libogg-1.1.3/doc/libogg/ogg_stream_init.html @ 15

Last change on this file since 15 was 15, checked in by landauf, 16 years ago

added libogg

File size: 1.7 KB
Line 
1<html>
2
3<head>
4<title>libogg - function - ogg_stream_init</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_init</h1>
17
18<p><i>declared in "ogg/ogg.h";</i></p>
19
20<p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_stream_state</a> struct and allocates appropriate memory in preparation for encoding or decoding.
21<p>It also assigns the stream a given serial number.
22<br><br>
23<table border=0 color=black cellspacing=0 cellpadding=7>
24<tr bgcolor=#cccccc>
25        <td>
26<pre><b>
27int ogg_stream_init(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,int serialno);
28</b></pre>
29        </td>
30</tr>
31</table>
32
33<h3>Parameters</h3>
34<dl>
35<dt><i>os</i></dt>
36<dd>Pointer to the ogg_stream_state struct that we will be initializing.</dd>
37<dt><i>serialno</i></dt>
38<dd>Serial number that we will attach to this stream.</dd>
39</dl>
40
41
42<h3>Return Values</h3>
43<blockquote>
44<li>
450 if successful</li>
46<li>
47-1 if unsuccessful.  If this fails, the ogg_stream_state was not properly declared before calling this function.</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>
Note: See TracBrowser for help on using the repository browser.