doc/vorbisfile/ov_time_total.html

   1 <html>
   2
   3 <head>
   4 <title>Vorbisfile - function - ov_time_total</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>Vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_time_total</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20
  21 <p>Returns the total time in seconds of the physical bitstream or a specified logical bitstream.
  22
  23
  24 <br><br>
  25 <table border=0 color=black cellspacing=0 cellpadding=7>
  26 <tr bgcolor=#cccccc>
  27         <td>
  28 <pre><b>
  29 double ov_time_total(OggVorbis_File *vf,int i);
  30 </b></pre>
  31         </td>
  32 </tr>
  33 </table>
  34
  35 <h3>Parameters</h3>
  36 <dl>
  37 <dt><i>vf</i></dt>
  38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
  39 functions.</dd>
  40 <dt><i>i</i></dt>
  41 <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>
  42 </dl>
  43
  44
  45 <h3>Return Values</h3>
  46 <blockquote>
  47 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is nonseekable.</li>
  48 <li><tt>n</tt> total length in seconds of content if i=-1.</li>
  49 <li><tt>n</tt> length in seconds of logical bitstream if i=0 to n.</li>
  50 </blockquote>
  51 <p>
  52
  53 <br><br>
  54 <hr noshade>
  55 <table border=0 width=100%>
  56 <tr valign=top>
  57 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
  58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  59 </tr><tr>
  60 <td><p class=tiny>Vorbisfile documentation</p></td>
  61 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
  62 </tr>
  63 </table>
  64
  65 </body>
  66
  67 </html>