doc/vorbisfile/ov_raw_seek_lap.html

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