Blame doc/vorbisenc/vorbis_encode_setup_init.html

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

Packit 06404a
Packit 06404a

declared in "vorbis/vorbisenc.h";

Packit 06404a
Packit 06404a

This function performs the last stage of three-step encoding setup, as described in the API overview under managed bitrate modes.

Packit 06404a
Packit 06404a

Before this function is called, the

Packit 06404a
href="../libvorbis/vorbis_info.html">vorbis_info struct should be initialized
Packit 06404a
by using vorbis_info_init() from the libvorbis API, one of 
Packit 06404a
href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()
Packit 06404a
or 
Packit 06404a
href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()
Packit 06404a
called to initialize the high-level encoding setup, and 
Packit 06404a
href="vorbis_encode_ctl.html">vorbis_encode_ctl() called if
Packit 06404a
necessary to make encoding setup changes.  vorbis_encode_setup_init()
Packit 06404a
finalizes the highlevel encoding structure into a complete encoding
Packit 06404a
setup after which the application may make no further setup changes.

Packit 06404a
Packit 06404a
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_setup_init(vorbis_info *vi);
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
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 - Attempt to use vorbis_encode_setup_init() without first calling one of
    • Packit 06404a
      href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()
      Packit 06404a
      or 
      Packit 06404a
      href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()
      Packit 06404a
      to initialize the high-level encoding setup
      Packit 06404a
      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>