ov_info.html 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. <html>
  2. <head>
  3. <title>Vorbisfile - function - ov_info</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.2.0 - 20070723</p></td>
  11. </tr>
  12. </table>
  13. <h1>ov_info</h1>
  14. <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  15. <p>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for the specified bitstream. For nonseekable files, always returns the current vorbis_info struct.
  16. <br><br>
  17. <table border=0 color=black cellspacing=0 cellpadding=7>
  18. <tr bgcolor=#cccccc>
  19. <td>
  20. <pre><b>
  21. vorbis_info *ov_info(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,int link);
  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 libvorbisfile
  30. functions. </dd>
  31. <dt><i>i</i></dt>
  32. <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</dd>
  33. </dl>
  34. <h3>Return Values</h3>
  35. <blockquote>
  36. <li>Returns the vorbis_info struct for the specified bitstream. Returns vorbis_info for current bitstream if the file is nonseekable or i=-1.</li>
  37. <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
  38. </blockquote>
  39. <p>
  40. <br><br>
  41. <hr noshade>
  42. <table border=0 width=100%>
  43. <tr valign=top>
  44. <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
  45. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  46. </tr><tr>
  47. <td><p class=tiny>Vorbisfile documentation</p></td>
  48. <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
  49. </tr>
  50. </table>
  51. </body>
  52. </html>