cannam@86: cannam@86: cannam@86: cannam@86: libvorbis - function - vorbis_synthesis_headerin cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libvorbis documentation

libvorbis version 1.3.2 - 20101101

cannam@86: cannam@86:

vorbis_synthesis_headerin

cannam@86: cannam@86:

declared in "vorbis/codec.h";

cannam@86: cannam@86:

This function decodes a header packet from a Vorbis stream and applies cannam@86: the contents to the given vorbis_info cannam@86: structure (to provide codec parameters to the decoder) and cannam@86: vorbis_comment structure (to provide cannam@86: access to the embedded Vorbis comments).

cannam@86: cannam@86:

Once the three Vorbis header packets (info, comments, cannam@86: and codebooks, in that order) have been passed to this cannam@86: function, the vorbis_info cannam@86: structure is ready to be used in a call to cannam@86: vorbis_synthesis_init.

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

cannam@86: extern int      vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
cannam@86:                                           ogg_packet *op);
cannam@86:
cannam@86:
cannam@86: cannam@86:

Parameters

cannam@86:
cannam@86:
vi
cannam@86:
The vorbis_info structure to apply cannam@86: the decoded information to.
cannam@86:
vc
cannam@86:
The vorbis_comment structure to cannam@86: apply the decoded comments to.
cannam@86:
op
cannam@86:
The ogg_packet to decode.
cannam@86:
cannam@86: cannam@86: cannam@86:

Return Values

cannam@86:
cannam@86:
  • 0 on success.
    • cannam@86:
  • OV_ENOTVORBIS if the packet is not a Vorbis header packet.
    • cannam@86:
  • OV_EBADHEADER if there was an error interpreting the packet.
    • cannam@86:
  • OV_EFAULT on internal error.
    • 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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

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