Chris@1: Chris@1: Chris@1: Chris@1: libvorbis - function - vorbis_analysis_headerout Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

libvorbis documentation

libvorbis version 1.3.2 - 20101101

Chris@1: Chris@1:

vorbis_analysis_headerout

Chris@1: Chris@1:

declared in "vorbis/codec.h";

Chris@1: Chris@1:

This function creates and returns the three header packets needed Chris@1: to configure a decoder to accept compressed data. I should be called Chris@1: after all encoder initialization and configuration is complete. The Chris@1: output packets should be placed in order at the start of the compressed Chris@1: vorbis stream, prior to the first data packet. Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

Chris@1:


Chris@1: extern int      vorbis_analysis_headerout(vorbis_dsp_state *v,
Chris@1:                                           vorbis_comment *vc,
Chris@1:                                           ogg_packet *op,
Chris@1:                                           ogg_packet *op_comm,
Chris@1:                                           ogg_packet *op_code);
Chris@1:

Chris@1:

Chris@1: Chris@1:

Parameters

Chris@1:

v: Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.
vc: Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.
op: Pointer to an ogg_packet structure to be filled out with the stream identification header.
op_comm: Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.
op_code: Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.

Chris@1: Chris@1: Chris@1:

Return Values

Chris@1:

0 for success
negative values for failure: Chris@1:
- OV_EFAULT - Internal fault; indicates a bug or memory corruption.
- OV_EIMPL - Unimplemented; not supported by this version of the library.
Chris@1:

Chris@1:

Chris@1: Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

copyright © 2010 Xiph.Org	Ogg Vorbis
libvorbis documentation	libvorbis version 1.3.2 - 20101101

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: