Blame doc/vorbisfile/ov_pcm_seek_lap.html

Packit 06404a
<html>
Packit 06404a
Packit 06404a
<head>
Packit 06404a
<title>Vorbisfile - function - ov_pcm_seek_lap</title>
Packit 06404a
<link rel=stylesheet href="style.css" type="text/css">
Packit 06404a
</head>
Packit 06404a
Packit 06404a
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Packit 06404a
Packit 06404a
Packit 06404a

Vorbisfile documentation

Packit 06404a

vorbisfile version 1.3.2 - 20101101

Packit 06404a
Packit 06404a
Packit 06404a
Packit 06404a

ov_pcm_seek_lap

Packit 06404a
Packit 06404a

declared in "vorbis/vorbisfile.h";

Packit 06404a
Packit 06404a

Seeks to the offset specified (in pcm samples) within the physical bitstream. This variant of

Packit 06404a
href="ov_pcm_seek.html">ov_pcm_seek also automatically
Packit 06404a
crosslaps the transition from the previous playback position into the
Packit 06404a
new playback position in order to eliminate clicking and boundary
Packit 06404a
discontinuities.  Otherwise, usage and behavior is identical to 
Packit 06404a
href="ov_pcm_seek.html">ov_pcm_seek.
Packit 06404a
Packit 06404a

ov_pcm_seek_lap also updates everything needed within the decoder,

Packit 06404a
so you can immediately call ov_read() and
Packit 06404a
get data from the newly seeked to position.
Packit 06404a
Packit 06404a

ov_pcm_seek_lap will lap between logical stream links of differing

Packit 06404a
numbers of channels. Any extra channels from the origin of the seek
Packit 06404a
are ignored; playback of these channels simply ends. Extra channels at
Packit 06404a
the destination are lapped from silence.  ov_pcm_seek_lap will also
Packit 06404a
lap between logical stream links of differing sample rates.  In this
Packit 06404a
case, the sample rates are ignored (no implicit resampling is done to
Packit 06404a
match playback). It is up to the application developer to decide if
Packit 06404a
this behavior makes any sense in a given context; in practical use,
Packit 06404a
these default behaviors perform sensibly.
Packit 06404a
Packit 06404a

This function only works for seekable streams.

Packit 06404a
Packit 06404a


Packit 06404a
Packit 06404a
Packit 06404a
	
Packit 06404a
Packit 06404a
int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
Packit 06404a
Packit 06404a
	
Packit 06404a
Packit 06404a
Packit 06404a
Packit 06404a

Parameters

Packit 06404a
Packit 06404a
vf
Packit 06404a
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
Packit 06404a
functions.
Packit 06404a
pos
Packit 06404a
Position in pcm samples to seek to in the bitstream.
Packit 06404a
Packit 06404a
Packit 06404a
Packit 06404a

Return Values

Packit 06404a
Packit 06404a
    Packit 06404a
  • 0 for success
  • Packit 06404a
    Packit 06404a
  • Packit 06404a
    nonzero indicates failure, described by several error codes:
    Packit 06404a
      
      Packit 06404a
        
    • OV_ENOSEEK - Bitstream is not seekable.
    • Packit 06404a
        
      Packit 06404a
        
    • OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
    • Packit 06404a
        
      Packit 06404a
        
    • OV_EREAD - A read from media returned an error.
    • Packit 06404a
        
      Packit 06404a
        
    • OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
    • Packit 06404a
      		corruption.
      Packit 06404a
        
      Packit 06404a
        
    • OV_EOF - Indicates stream is at end of file immediately after a seek
    • Packit 06404a
        (making crosslap impossible as there's no preceeding decode state to crosslap).
      Packit 06404a
        
      Packit 06404a
        
    • OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
    • Packit 06404a
        
      Packit 06404a
        
      Packit 06404a
      Packit 06404a
      Packit 06404a


      Packit 06404a

      Packit 06404a
      Packit 06404a
      Packit 06404a

      copyright © 2000-2010 Xiph.Org

      Packit 06404a

      Ogg Vorbis

      Packit 06404a
      Packit 06404a

      Vorbisfile documentation

      Packit 06404a

      vorbisfile version 1.3.2 - 20101101

      Packit 06404a
      Packit 06404a
      Packit 06404a
      Packit 06404a
      </body>
      Packit 06404a
      Packit 06404a
      </html>