Mercurial > hg > sv-dependency-builds
annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_comment.html @ 127:7867fa7e1b6b
Current fftw source
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 18 Oct 2016 13:40:26 +0100 |
| parents | 98c1576536ae |
| children |
| rev | line source |
|---|---|
| cannam@86 | 1 <html> |
| cannam@86 | 2 |
| cannam@86 | 3 <head> |
| cannam@86 | 4 <title>Vorbisfile - function - ov_bitrate</title> |
| cannam@86 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| cannam@86 | 6 </head> |
| cannam@86 | 7 |
| cannam@86 | 8 |
| cannam@86 | 9 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| cannam@86 | 10 <table border=0 width=100%> |
| cannam@86 | 11 <tr> |
| cannam@86 | 12 <td><p class=tiny>Vorbisfile documentation</p></td> |
| cannam@86 | 13 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> |
| cannam@86 | 14 </tr> |
| cannam@86 | 15 </table> |
| cannam@86 | 16 |
| cannam@86 | 17 <h1>ov_comment</h1> |
| cannam@86 | 18 |
| cannam@86 | 19 <p><i>declared in "vorbis/vorbisfile.h";</i></p> |
| cannam@86 | 20 |
| cannam@86 | 21 <p>Returns a pointer to the <a href="../libvorbis/vorbis_comment.html">vorbis_comment</a> struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream. |
| cannam@86 | 22 <p> |
| cannam@86 | 23 |
| cannam@86 | 24 <br><br> |
| cannam@86 | 25 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 26 <tr bgcolor=#cccccc> |
| cannam@86 | 27 <td> |
| cannam@86 | 28 <pre><b> |
| cannam@86 | 29 vorbis_comment *ov_comment(OggVorbis_File *vf,int link); |
| cannam@86 | 30 </b></pre> |
| cannam@86 | 31 </td> |
| cannam@86 | 32 </tr> |
| cannam@86 | 33 </table> |
| cannam@86 | 34 |
| cannam@86 | 35 <h3>Parameters</h3> |
| cannam@86 | 36 <dl> |
| cannam@86 | 37 <dt><i>vf</i></dt> |
| cannam@86 | 38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile |
| cannam@86 | 39 functions.</dd> |
| cannam@86 | 40 <dt><i>i</i></dt> |
| cannam@86 | 41 <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="../libvorbis/vorbis_comment.html">vorbis_comment</a> struct for the current bitstream, this parameter should be set to -1.</dd> |
| cannam@86 | 42 </dl> |
| cannam@86 | 43 |
| cannam@86 | 44 |
| cannam@86 | 45 <h3>Return Values</h3> |
| cannam@86 | 46 <blockquote> |
| cannam@86 | 47 <li>Returns the vorbis_comment struct for the specified bitstream.</li> |
| cannam@86 | 48 <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li> |
| cannam@86 | 49 </blockquote> |
| cannam@86 | 50 <p> |
| cannam@86 | 51 |
| cannam@86 | 52 <br><br> |
| cannam@86 | 53 <hr noshade> |
| cannam@86 | 54 <table border=0 width=100%> |
| cannam@86 | 55 <tr valign=top> |
| cannam@86 | 56 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> |
| cannam@86 | 57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| cannam@86 | 58 </tr><tr> |
| cannam@86 | 59 <td><p class=tiny>Vorbisfile documentation</p></td> |
| cannam@86 | 60 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> |
| cannam@86 | 61 </tr> |
| cannam@86 | 62 </table> |
| cannam@86 | 63 |
| cannam@86 | 64 </body> |
| cannam@86 | 65 |
| cannam@86 | 66 </html> |