doc/vorbisfile/ov_pcm_total.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_pcm_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.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_pcm_total</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p>Returns the total pcm samples of the physical bitstream or a specified logical bitstream.
  21
  22 <br><br>
  23 <table border=0 color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>
  27 int64_t ov_pcm_total(OggVorbis_File *vf,int i);
  28 </b></pre>
  29         </td>
  30 </tr>
  31 </table>
  32
  33 <h3>Parameters</h3>
  34 <dl>
  35 <dt><i>vf</i></dt>
  36 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  37 functions.</dd>
  38 <dt><i>i</i></dt>
  39 <dd>Link to the desired logical bitstream.  To retrieve the total pcm samples for the entire physical bitstream, this parameter should be set to -1.</dd>
  40 </dl>
  41
  42
  43 <h3>Return Values</h3>
  44 <blockquote>\r
  45 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is unseekable.</li>
  46 <li>
  47 total length in pcm samples of content if i=-1.</li>
  48 <li>length in pcm samples of logical bitstream if i=1 to n.</li>
  49 </blockquote>
  50 <p>
  51 <br><br>
  52 <hr noshade>
  53 <table border=0 width=100%>
  54 <tr valign=top>
  55 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  56 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  57 </tr><tr>
  58 <td><p class=tiny>vorbisfile documentation</p></td>
  59 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  60 </tr>
  61 </table>
  62
  63
  64 </body>
  65
  66 </html>