ov_pcm_total.html 1.7 KB

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