libvorbisenc documentation

libvorbisenc release 1.1 - 20040709


declared in "vorbis/libvorbisenc.h";

This is the primary function within libvorbisenc for setting up variable bitrate ("quality" based) modes.

Before this function is called, the vorbis_info struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.

extern int vorbis_encode_init_vbr(vorbis_info *vi,
			      long channels,
			      long rate,
			      float base_quality);


File pointer to an initialized vorbis_info struct.
The number of channels to be encoded.
The sampling rate of the source audio.
Desired quality level, currently from -0.1 to 1.0 (lo to hi).

Return Values

  • 0 for success
  • less than zero for failure:
    • OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.
    • OV_EINVAL - Invalid setup request, eg, out of range argument.
    • OV_EIMPL - Unimplemented mode; unable to comply with quality level request.

    copyright © 2004

    Ogg Vorbis

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20040709