cannam@86: cannam@86: cannam@86: cannam@86: libvorbisenc - function - vorbis_encode_init cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libvorbisenc documentation

libvorbisenc version 1.3.2 - 20101101

cannam@86: cannam@86:

vorbis_encode_init

cannam@86: cannam@86:

declared in "vorbis/vorbisenc.h";

cannam@86: cannam@86:

This is the primary function within libvorbisenc for setting up managed bitrate modes. cannam@86:

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. cannam@86:

The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up. cannam@86:

cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: 

cannam@86: extern int vorbis_encode_init(vorbis_info *vi,
cannam@86: 			      long channels,
cannam@86: 			      long rate,
cannam@86: 			      
cannam@86: 			      long max_bitrate,
cannam@86: 			      long nominal_bitrate,
cannam@86: 			      long min_bitrate);
cannam@86: 
cannam@86:
cannam@86:
cannam@86: cannam@86:

Parameters

cannam@86:
cannam@86:
vi
cannam@86:
Pointer to an initialized vorbis_info struct.
cannam@86:
channels
cannam@86:
The number of channels to be encoded.
cannam@86:
rate
cannam@86:
The sampling rate of the source audio.
cannam@86:
max_bitrate
cannam@86:
Desired maximum bitrate (limit). -1 indicates unset.
cannam@86:
nominal_bitrate
cannam@86:
Desired average, or central, bitrate. -1 indicates unset.
cannam@86:
min_bitrate
cannam@86:
Desired minimum bitrate. -1 indicates unset.
cannam@86:
cannam@86: cannam@86: cannam@86:

Return Values

cannam@86:
cannam@86:
  • cannam@86: 0 for success
    • cannam@86: cannam@86:
  • less than zero for failure:
    • cannam@86: cannam@86:
    cannam@86:

    cannam@86: cannam@86:

    cannam@86:

    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    libvorbisenc documentation

    libvorbisenc version 1.3.2 - 20101101

    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: