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/libvorbis/vorbis_synthesis_headerin.html | 80 ++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 doc/libvorbis/vorbis_synthesis_headerin.html (limited to 'doc/libvorbis/vorbis_synthesis_headerin.html') diff --git a/doc/libvorbis/vorbis_synthesis_headerin.html b/doc/libvorbis/vorbis_synthesis_headerin.html new file mode 100644 index 0000000..835d8ce --- /dev/null +++ b/doc/libvorbis/vorbis_synthesis_headerin.html @@ -0,0 +1,80 @@ + + + +libvorbis - function - vorbis_synthesis_headerin + + + + + + + + + +

libvorbis documentation

libvorbis version 1.3.2 - 20101101

+ +

vorbis_synthesis_headerin

+ +

declared in "vorbis/codec.h";

+ +

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

+ +

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

+ + + + + +
+

+extern int      vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
+                                          ogg_packet *op);
+
+
+ +

Parameters

+
+
vi
+
The vorbis_info structure to apply +the decoded information to.
+
vc
+
The vorbis_comment structure to +apply the decoded comments to.
+
op
+
The ogg_packet to decode.
+
+ + +

Return Values

+
+
  • 0 on success.
    • +
  • OV_ENOTVORBIS if the packet is not a Vorbis header packet.
    • +
  • OV_EBADHEADER if there was an error interpreting the packet.
    • +
  • OV_EFAULT on internal error.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    + + + + + -- cgit v1.1