diff options
| author | Monty <xiphmont@xiph.org> | 2002-09-02 22:17:22 +0000 |
|---|---|---|
| committer | Monty <xiphmont@xiph.org> | 2002-09-02 22:17:22 +0000 |
| commit | 6e70b36ec8818a090e90d0dea18b78860d1b006c (patch) | |
| tree | 67007d05d937aee95255893db26389591939e153 /doc/ov_raw_total.html | |
| parent | 56fbebdcf71ea7c8e64cb18ac3a78e5834134fa3 (diff) | |
| download | tremor-6e70b36ec8818a090e90d0dea18b78860d1b006c.tar.gz | |
Add Tremor docs to CVS
git-svn-id: https://svn.xiph.org/trunk/Tremor@3891 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc/ov_raw_total.html')
| -rw-r--r-- | doc/ov_raw_total.html | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/ov_raw_total.html b/doc/ov_raw_total.html new file mode 100644 index 0000000..d0af35f --- /dev/null +++ b/doc/ov_raw_total.html @@ -0,0 +1,68 @@ +<html> + +<head> +<title>Tremor - function - ov_raw_total</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>Tremor documentation</p></td> +<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> +</tr> +</table> + +<h1>ov_raw_total</h1> + +<p><i>declared in "ivorbisfile.h";</i></p> + +<p>Returns the total (compressed) bytes of the physical bitstream or a specified logical bitstream. + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>vf</i></dt> +<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec +functions.</dd> +<dt><i>i</i></dt> +<dd>Link to the desired logical bitstream. To retrieve the total bytes for the entire physical bitstream, this parameter should be set to -1.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li>OV_EINVAL means that the argument was invalid. In this case, the requested bitstream did not exist or the bitstream is nonseekable</li> +<li><tt>n</tt> +total length in compressed bytes of content if i=-1.</li> +<li><tt>n</tt> length in compressed bytes of logical bitstream if i=1 to n.</li> +</blockquote> +<p> + + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2002 Xiph.org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> +</tr><tr> +<td><p class=tiny>Tremor documentation</p></td> +<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> +</tr> +</table> + +</body> + +</html> |