Imported Upstream version 1.3.3
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_granule_time.html
1 <html>
2
3 <head>
4 <title>libvorbis - function - vorbis_granule_time</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>libvorbis documentation</p></td>
12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
13 </tr>
14 </table>
15
16 <h1>vorbis_granule_time</h1>
17
18 <p><i>declared in "vorbis/codec.h";</i></p>
19
20 <p>This function converts a granule position to a time for a given Vorbis stream.</p>
21
22 <table border=0 color=black cellspacing=0 cellpadding=7>
23 <tr bgcolor=#cccccc>
24         <td>
25 <pre><b>
26 extern double   vorbis_granule_time(vorbis_dsp_state *v,
27                                     ogg_int64_t granulepos);
28 </b></pre>
29         </td>
30 </tr>
31 </table>
32
33 <h3>Parameters</h3>
34 <dl>
35 <dt><i>v</i></dt>
36 <dd>Pointer to the vorbis_dsp_state for the stream.</dd>
37 <dt><i>granulepos</i></dt>
38 <dd>The granule position.</dd>
39 </dl>
40
41
42 <h3>Return Values</h3>
43 <blockquote>
44 <li>
45 The time (in seconds) corresponding to the granulepos.</li>
46 <li>-1 if the given granulepos is negative</li>
47 </blockquote>
48 <p>
49
50 <br><br>
51 <hr noshade>
52 <table border=0 width=100%>
53 <tr valign=top>
54 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
56 </tr><tr>
57 <td><p class=tiny>libvorbis documentation</p></td>
58 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
59 </tr>
60 </table>
61
62
63 </body>
64
65 </html>