ov_time_total.html 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <html>
  2. <head>
  3. <title>vorbisfile - function - ov_time_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>vorbisfile documentation</p></td>
  10. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  11. </tr>
  12. </table>
  13. <h1>ov_time_total</h1>
  14. <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  15. <p>Returns the total time in seconds 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. double ov_time_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 vorbisfile
  30. functions. Once this has been called, the same <tt>OggVorbis_File</tt>
  31. struct should be passed to all the vorbisfile functions.</dd>
  32. <dt><i>i</i></dt>
  33. <dd><b>Link to the desired logical bitstream. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</b></dd>
  34. </dl>
  35. <h3>Return Values</h3>
  36. <blockquote>
  37. <li>OV_EINVAL means that the argument was invalid. In this case, the requested bitstream did not exist or the bitstream is nonseekable.</li>
  38. <li>
  39. total length in seconds of content if i=-1.</li>
  40. <li>length in seconds of logical bitstream if i=1 to n.</li>
  41. </blockquote>
  42. <p>
  43. <h3>Notes</h3>
  44. <p><b>Typical usage:</b> <tt>bytes_read = ov_read(&amp;vf, buffer, 4096,0,2,1,&amp;current_section)</tt>
  45. <br>This reads up to 4096 bytes into a buffer, with signed 16-bit little-endian
  46. samples.
  47. <br>
  48. <br><br>
  49. <hr noshade>
  50. <table border=0 width=100%>
  51. <tr valign=top>
  52. <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  53. <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>
  54. </tr><tr>
  55. <td><p class=tiny>vorbisfile documentation</p></td>
  56. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  57. </tr>
  58. </table>
  59. </body>
  60. </html>