From 74f4b1bc3b627ba4c7e03498234d88cacdfbe97b Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:49 +0200 Subject: Squashed 'vorbis/' content from commit d22c3ab5f git-subtree-dir: vorbis git-subtree-split: d22c3ab5f633460abc2532feee60ca0892134cbf --- doc/vorbisenc/vorbis_encode_init.html | 88 +++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 doc/vorbisenc/vorbis_encode_init.html (limited to 'doc/vorbisenc/vorbis_encode_init.html') diff --git a/doc/vorbisenc/vorbis_encode_init.html b/doc/vorbisenc/vorbis_encode_init.html new file mode 100644 index 0000000..d371899 --- /dev/null +++ b/doc/vorbisenc/vorbis_encode_init.html @@ -0,0 +1,88 @@ + + + +libvorbisenc - function - vorbis_encode_init + + + + + + + + + +

libvorbisenc documentation

libvorbisenc version 1.3.2 - 20101101

+ +

vorbis_encode_init

+ +

declared in "vorbis/vorbisenc.h";

+ +

This is the primary function within libvorbisenc for setting up managed bitrate 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. +

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(vorbis_info *vi,
+			      long channels,
+			      long rate,
+			      
+			      long max_bitrate,
+			      long nominal_bitrate,
+			      long min_bitrate);
+
+
+
+ +

Parameters

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

Return Values

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

    + +

    +

    + + + + + + + + +

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    libvorbisenc documentation

    libvorbisenc version 1.3.2 - 20101101

    + + + + + -- cgit v1.1