Vorbisfile documentation | vorbisfile version 1.2.0 - 20070723

# vorbis_comment

declared in "vorbis/codec.h"

The vorbis_comment structure defines an Ogg Vorbis comment.

Only the fields the program needs must be defined. If a field isn't defined by the application, it will either be blank (if it's a string value) or set to some reasonable default (usually 0).

    typedef struct vorbis_comment{
      /* unlimited user comment fields. */
      char **user_comments;
      int  *comment_lengths;
      int  comments;
      char *vendor;

    } vorbis_comment;

### Parameters

user_comments
  Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the `comment_lengths` array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).
comment_lengths
  An int array that stores the length of each comment string
comments
  Int signifying number of user comments in user_comments field.
vendor
  Information about the creator of the file. Stored in a standard C 0-terminated string.

copyright © 2007 Xiph.org | Ogg Vorbis
Vorbisfile documentation | vorbisfile version 1.2.0 - 20070723