annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_time_seek_lap.html @ 56:af97cad61ff0

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