Vorbis, Speex and Theora bitstreams use a comment format called "Vorbiscomment", defined here. Many standard comment names (such as TITLE, COPYRIGHT and GENRE) are defined in that document.
The following general features of Vorbiscomment are relevant to this API:
Each comment block contains one Vendor string, which can be retrieved with oggz_comment_get_vendor().
The rest of a comment block consists of name = value pairs, with the following restrictions:
#include <oggz/oggz.h>
Go to the source code of this file.
Data Structures | |
struct | OggzComment |
A comment. More... | |
Functions | |
const char * | oggz_comment_get_vendor (OGGZ *oggz, long serialno) |
Retrieve the vendor string. | |
int | oggz_comment_set_vendor (OGGZ *oggz, long serialno, const char *vendor_string) |
Set the vendor string. | |
const OggzComment * | oggz_comment_first (OGGZ *oggz, long serialno) |
Retrieve the first comment. | |
const OggzComment * | oggz_comment_next (OGGZ *oggz, long serialno, const OggzComment *comment) |
Retrieve the next comment. | |
const OggzComment * | oggz_comment_first_byname (OGGZ *oggz, long serialno, char *name) |
Retrieve the first comment with a given name. | |
const OggzComment * | oggz_comment_next_byname (OGGZ *oggz, long serialno, const OggzComment *comment) |
Retrieve the next comment following and with the same name as a given comment. | |
int | oggz_comment_add (OGGZ *oggz, long serialno, OggzComment *comment) |
Add a comment. | |
int | oggz_comment_add_byname (OGGZ *oggz, long serialno, const char *name, const char *value) |
Add a comment by name and value. | |
int | oggz_comment_remove (OGGZ *oggz, long serialno, OggzComment *comment) |
Remove a comment. | |
int | oggz_comment_remove_byname (OGGZ *oggz, long serialno, char *name) |
Remove all comments with a given name. | |
ogg_packet * | oggz_comments_generate (OGGZ *oggz, long serialno, int FLAC_final_metadata_block) |
Output a comment packet for the specified stream. | |
int | oggz_comments_copy (OGGZ *src, long src_serialno, OGGZ *dest, long dest_serialno) |
void | oggz_packet_destroy (ogg_packet *packet) |
Free a packet and its payload. |
|
Add a comment.
|
|
Add a comment by name and value.
|
|
Retrieve the first comment.
|
|
Retrieve the first comment with a given name.
|
|
Retrieve the vendor string.
|
|
Retrieve the next comment.
|
|
Retrieve the next comment following and with the same name as a given comment.
|
|
Remove a comment.
|
|
Remove all comments with a given name.
|
|
Set the vendor string.
|
|
Output a comment packet for the specified stream.
|
|
Free a packet and its payload.
|