diff options
Diffstat (limited to 'doc/ov_test_open.html')
-rw-r--r-- | doc/ov_test_open.html | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/ov_test_open.html b/doc/ov_test_open.html new file mode 100644 index 0000000..74f4410 --- /dev/null +++ b/doc/ov_test_open.html @@ -0,0 +1,82 @@ +<html> + +<head> +<title>Tremor - function - ov_test_open</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_test_open</h1> + +<p><i>declared in "ivorbisfile.h";</i></p> + +<p> +Finish opening a file partially opened with <a href="ov_test.html">ov_test()</a> +or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>. +<p> + +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ov_test_open(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf); +</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. Once this has been called, the same <tt>OggVorbis_File</tt> +struct should be passed to all the libvorbisidec functions.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 for success</li> + +<li>less than zero for failure:</li> +<ul> +<li>OV_EREAD - A read from media returned an error.</li> +<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li> +<li>OV_EVERSION - Vorbis version mismatch.</li> +<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li> +<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li> +</ul> +</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> + + + + + + + |