diff options
| author | Ralph Giles <giles@xiph.org> | 2002-07-19 11:54:50 +0000 |
|---|---|---|
| committer | Ralph Giles <giles@xiph.org> | 2002-07-19 11:54:50 +0000 |
| commit | 9ec2da4a81070cfa13745063238d353bbf8ab403 (patch) | |
| tree | 99f96add79f997714398f1d04faa1a7872a40130 /doc | |
| parent | 7492d311f549b82de32f1ba54477a9ea8552df28 (diff) | |
| download | ogg-git-9ec2da4a81070cfa13745063238d353bbf8ab403.tar.gz | |
add documentation for new routine ogg_stream_reset_serialno();
svn path=/trunk/ogg/; revision=3690
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ogg/ogg_stream_reset_serialno.html | 67 | ||||
| -rw-r--r-- | doc/ogg/reference.html | 7 |
2 files changed, 71 insertions, 3 deletions
diff --git a/doc/ogg/ogg_stream_reset_serialno.html b/doc/ogg/ogg_stream_reset_serialno.html new file mode 100644 index 0000000..ce3447a --- /dev/null +++ b/doc/ogg/ogg_stream_reset_serialno.html @@ -0,0 +1,67 @@ +<html> + +<head> +<title>libogg - function - ogg_stream_reset</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 version 1.25 - 20020719</p></td> +</tr> +</table> + +<h1>ogg_stream_reset</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function reinitializes the values in the +<a href="ogg_stream_state.html">ogg_stream_state</a>, +just like <a href="ogg_stream_reset.html">ogg_stream_reset()</a>. +Additionally, it sets the stream serial number to the given value.</p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_stream_reset(ogg_stream_state *os, int serialno); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>os</i></dt> +<dd>Pointer to the ogg_stream_state struct to be cleared.</dd> +<dt><i>serialno</i></dt> +<dd>New stream serial number to use</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is always returned.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> +<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> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg version 1.25 - 20020719</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/ogg/reference.html b/doc/ogg/reference.html index 9b11fa3..eddb2af 100644 --- a/doc/ogg/reference.html +++ b/doc/ogg/reference.html @@ -9,7 +9,7 @@ <table border=0 width=100%> <tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg - 20011218</p></td> +<td align=right><p class=tiny>libogg - 20020719</p></td> </tr> </table> @@ -64,6 +64,7 @@ <a href="ogg_stream_init.html">ogg_stream_init()</a><br> <a href="ogg_stream_clear.html">ogg_stream_clear()</a><br> <a href="ogg_stream_reset.html">ogg_stream_reset()</a><br> +<a href="ogg_stream_reset_serialno.html">ogg_stream_reset_serialno()</a><br> <a href="ogg_stream_destroy.html">ogg_stream_destroy()</a><br> <a href="ogg_page_version.html">ogg_page_version()</a><br> <a href="ogg_page_continued.html">ogg_page_continued()</a><br> @@ -79,11 +80,11 @@ <hr noshade> <table border=0 width=100%> <tr valign=top> -<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td> <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> </tr><tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg - 20011218</p></td> +<td align=right><p class=tiny>libogg - 20020719</p></td> </tr> </table> |