Blame doc/vorbisenc/vorbis_encode_setup_vbr.html

Packit 06404a
<html>
Packit 06404a
Packit 06404a
<head>
Packit 06404a
<title>libvorbisenc - function - vorbis_encode_setup_vbr</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

libvorbisenc documentation

Packit 06404a

libvorbisenc version 1.3.2 - 20101101

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

vorbis_encode_setup_vbr

Packit 06404a
Packit 06404a

declared in "vorbis/vorbisenc.h";

Packit 06404a
Packit 06404a

This function performs step-one of a three-step variable bitrate

Packit 06404a
(quality-based) encode setup.  It functions similarly to the one-step
Packit 06404a
setup performed by 
Packit 06404a
href="vorbis_encode_init_vbr.html">vorbis_encode_init_vbr() but
Packit 06404a
allows an application to make further encode setup tweaks using 
Packit 06404a
href="vorbis_encode_ctl.html">vorbis_encode_ctl() before finally
Packit 06404a
calling 
Packit 06404a
href="vorbis_encode_setup_init.html">vorbis_encode_setup_init() to
Packit 06404a
complete the setup process.
Packit 06404a
Packit 06404a

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.

Packit 06404a

Packit 06404a


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

Parameters

Packit 06404a
Packit 06404a
vi
Packit 06404a
Pointer to an initialized vorbis_info struct.
Packit 06404a
channels
Packit 06404a
The number of channels to be encoded.
Packit 06404a
rate
Packit 06404a
The sampling rate of the source audio.
Packit 06404a
base_quality
Packit 06404a
Desired quality level, currently from -0.1 to 1.0 (lo to hi).
Packit 06404a
Packit 06404a
Packit 06404a
Packit 06404a

Return Values

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

      libvorbisenc documentation

      Packit 06404a

      libvorbisenc version 1.3.2 - 20101101

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