From 101373b1033193ee383e064d10dc033424111f9b Mon Sep 17 00:00:00 2001 From: Jack Moffitt Date: Wed, 19 Dec 2001 02:11:38 +0000 Subject: [PATCH] Some vorbisenc api doc updates. svn path=/trunk/vorbis/; revision=2836 --- doc/vorbisenc/Makefile.am | 3 +- doc/vorbisenc/overview.html | 5 ++ doc/vorbisenc/vorbis_encode_init_vbr.html | 80 +++++++++++++++++++++++++++++++ 3 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 doc/vorbisenc/vorbis_encode_init_vbr.html diff --git a/doc/vorbisenc/Makefile.am b/doc/vorbisenc/Makefile.am index 3eca0bb..a9f7809 100644 --- a/doc/vorbisenc/Makefile.am +++ b/doc/vorbisenc/Makefile.am @@ -5,6 +5,7 @@ AUTOMAKE_OPTIONS = foreign docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/vorbisenc doc_DATA = index.html overview.html reference.html style.css\ - vorbis_encode_ctl.html vorbis_encode_init.html vorbis_info.html + vorbis_encode_ctl.html vorbis_encode_init.html vorbis_info.html\ + vorbis_encode_init_vbr.html EXTRA_DIST = $(doc_DATA) diff --git a/doc/vorbisenc/overview.html b/doc/vorbisenc/overview.html index 1be1ea2..d396b8f 100644 --- a/doc/vorbisenc/overview.html +++ b/doc/vorbisenc/overview.html @@ -31,6 +31,11 @@ All the libvorbisenc routines are declared in "vorbis/vorbisenc.h". This function takes a vorbis_info struct and encoding parameters and sets up a proper encoding environment.. +vorbis_encode_init_vbr +This function takes a vorbis_info struct +and encoding parameters for VBR encoding. + + vorbis_encode_ctl Function in progress, to be used in future versions of this API. diff --git a/doc/vorbisenc/vorbis_encode_init_vbr.html b/doc/vorbisenc/vorbis_encode_init_vbr.html new file mode 100644 index 0000000..21d8b4f --- /dev/null +++ b/doc/vorbisenc/vorbis_encode_init_vbr.html @@ -0,0 +1,80 @@ + + + +libvorbisenc - function - vorbis_encode_init_vbr + + + + + + + + + +

libvorbisenc documentation

libvorbisenc - 20011218

+ +

vorbis_encode_init_vbr

+ +

declared in "vorbis/libvorbisenc.h";

+ +

This is the primary function within libvorbisenc. This is used to properly set up an encoding environment using libvorbisenc. +

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. +

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. +

+

+ + + + +
+

+extern int vorbis_encode_init_vbr(vorbis_info *vi,
+			      long channels,
+			      long rate,
+			      
+			      float base_quality /* from 0. (lo) to 1. (hi) */);
+
+
+
+ +

Parameters

+
+
vi
+
File pointer to an initialized vorbis_info struct.
+
channels
+
The number of channels to be encoded.
+
rate
+
The sampling rate of the source audio.
+
base_quality
+
Desired quality level from 0.0 to 1.0 (lo to hi).
+
+ + +

Return Values

+
+
  • +0 for success
    • + +
  • less than zero for failure:
    • + +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000 xiph.org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc version 1.1.2.2 - 20001106

    + + + + + -- 2.7.4