annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_pcm_seek_lap.html @ 169:223a55898ab9 tip default

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