examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/ov_time_total.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - function - ov_time_total</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ov_time_total</h1>
00017 
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019 
00020 
00021 <p>Returns the total time in seconds of the physical bitstream or a specified logical bitstream.
00022 
00023 
00024 <br><br>
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027         <td>
00028 <pre><b>
00029 double ov_time_total(OggVorbis_File *vf,int i);
00030 </b></pre>
00031         </td>
00032 </tr>
00033 </table>
00034 
00035 <h3>Parameters</h3>
00036 <dl>
00037 <dt><i>vf</i></dt>
00038 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
00039 functions.</dd>
00040 <dt><i>i</i></dt>
00041 <dd>Link to the desired logical bitstream.  To retrieve the time total for the entire physical bitstream, this parameter should be set to -1.</b></dd>
00042 </dl>
00043 
00044 
00045 <h3>Return Values</h3>
00046 <blockquote>
00047 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is nonseekable.</li>
00048 <li><tt>n</tt> total length in seconds of content if i=-1.</li>
00049 <li><tt>n</tt> length in seconds of logical bitstream if i=0 to n.</li>
00050 </blockquote>
00051 <p>
00052 
00053 <br><br>
00054 <hr noshade>
00055 <table border=0 width=100%>
00056 <tr valign=top>
00057 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00058 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00059 </tr><tr>
00060 <td><p class=tiny>Vorbisfile documentation</p></td>
00061 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00062 </tr>
00063 </table>
00064 
00065 </body>
00066 
00067 </html>

Generated by  doxygen 1.6.2