diff options
author | Ralph Giles <giles@xiph.org> | 2005-07-30 23:43:51 +0000 |
---|---|---|
committer | Ralph Giles <giles@xiph.org> | 2005-07-30 23:43:51 +0000 |
commit | 6e275ac670397fa0d54fe2897ac3d058cb3055dd (patch) | |
tree | 8755b26c9991c1c158115531a5d76e12c4714ceb /doc/libogg/oggpack_read1.html | |
parent | d0acdd7d7ea78127d1e2f0e57164c20104c6bb69 (diff) | |
download | ogg-git-6e275ac670397fa0d54fe2897ac3d058cb3055dd.tar.gz |
Rename the libogg api doc directory to doc/libogg for greater clarity.
svn path=/trunk/ogg/; revision=9667
Diffstat (limited to 'doc/libogg/oggpack_read1.html')
-rw-r--r-- | doc/libogg/oggpack_read1.html | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/libogg/oggpack_read1.html b/doc/libogg/oggpack_read1.html new file mode 100644 index 0000000..e697a60 --- /dev/null +++ b/doc/libogg/oggpack_read1.html @@ -0,0 +1,63 @@ +<html> + +<head> +<title>libogg - function - oggpack_read1</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.0 - 20000615</p></td> +</tr> +</table> + +<h1>oggpack_read1</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function reads one bit from the <a href="oggpack_buffer.html">oggpack_buffer</a> data buffer and advances the location pointer. +<p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +long oggpack_read1(oggpack_buffer *b); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>b</i></dt> +<dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +<i>n</i> is the bit read by this function.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000 xiph.org</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 release 1.0 - 20000615</p></td> +</tr> +</table> + + +</body> + +</html> |