Chris@1: Chris@1: Chris@1: Chris@1: libvorbis - function - vorbis_synthesis_headerin 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_synthesis_headerin

Chris@1: Chris@1:

declared in "vorbis/codec.h";

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

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

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

Parameters

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

Return Values

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