doc/vorbisfile/ov_time_seek_lap.html

   1 <html>
   2
   3 <head>
   4 <title>Vorbisfile - function - ov_time_seek_lap</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>Vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_time_seek_lap</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p>For seekable
  21 streams, ov_time_seek_lap seeks to the given time. This variant of <a
  22 href="ov_time_seek.html">ov_time_seek</a> also automatically
  23 crosslaps the transition from the previous playback position into the
  24 new playback position in order to eliminate clicking and boundary
  25 discontinuities.  Otherwise, usage and behavior is identical to <a
  26 href="ov_time_seek.html">ov_time_seek</a>.
  27
  28 <p>ov_time_seek_lap also updates everything needed within the decoder,
  29 so you can immediately call <a href="ov_read.html">ov_read()</a> and
  30 get data from the newly seeked to position.
  31
  32 <p>ov_time_seek_lap will lap between logical stream links of differing
  33 numbers of channels. Any extra channels from the origin of the seek
  34 are ignored; playback of these channels simply ends. Extra channels at
  35 the destination are lapped from silence.  ov_time_seek_lap will also
  36 lap between logical stream links of differing sample rates.  In this
  37 case, the sample rates are ignored (no implicit resampling is done to
  38 match playback). It is up to the application developer to decide if
  39 this behavior makes any sense in a given context; in practical use,
  40 these default behaviors perform sensibly.
  41
  42 <p> This function does not work for unseekable streams.
  43
  44
  45 <br><br>
  46 <table border=0 color=black cellspacing=0 cellpadding=7>
  47 <tr bgcolor=#cccccc>
  48         <td>
  49 <pre><b>
  50 int ov_time_seek_lap(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
  51 </b></pre>
  52         </td>
  53 </tr>
  54 </table>
  55
  56 <h3>Parameters</h3>
  57 <dl>
  58 <dt><i>vf</i></dt>
  59 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
  60 <dt><i>pos</i></dt>
  61 <dd>Location to seek to within the file, specified in seconds.</dd>
  62 </dl>
  63
  64
  65 <h3>Return Values</h3>
  66 <blockquote>
  67 <ul>
  68 <li>0 for success</li>
  69
  70 <li>
  71 nonzero indicates failure, described by several error codes:
  72   <ul>
  73   <li>OV_ENOSEEK - Bitstream is not seekable.
  74   </li>
  75   <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
  76   </li>
  77   <li>OV_EREAD - A read from media returned an error.
  78   </li>
  79   <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
  80                 corruption.
  81   </li>
  82   <li>OV_EOF - Indicates stream is at end of file immediately after a seek
  83   (making crosslap impossible as there's no preceeding decode state to crosslap).
  84   </li>
  85   <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
  86   </li>
  87   </ul></li>
  88 </ul></blockquote>
  89
  90
  91 <br><br>
  92 <hr noshade>
  93 <table border=0 width=100%>
  94 <tr valign=top>
  95 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
  96 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  97 </tr><tr>
  98 <td><p class=tiny>Vorbisfile documentation</p></td>
  99 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
 100 </tr>
 101 </table>
 102
 103 </body>
 104
 105 </html>