libmpg123: mpg123_id3v2 Struct Reference

download : svn :: features :: sf.net project - bug tracker :: news archive

libmpg123 API :: hacking :: testing :: benchmarking :: FAQ :: links :: contact

Note: This API doc is automatically generated from the current development version that you can get via Subversion or as a daily snapshot from http://mpg123.org/snapshot. There may be differences (additions) compared to the latest stable release. See NEWS.libmpg123 and the overall NEWS file on libmpg123 versions and important changes between them.
Let me emphasize that the policy for libmpg123 is to always stay backwards compatible -- only additions are planned (and it's not yet planned to change the plans;-).

#include <mpg123.h>

Data Fields
unsigned char	version
mpg123_string *	title
mpg123_string *	artist
mpg123_string *	album
mpg123_string *	year
mpg123_string *	genre
mpg123_string *	comment
mpg123_text *	comment_list
size_t	comments
mpg123_text *	text
size_t	texts
mpg123_text *	extra
size_t	extras

Detailed Description

Data structure for storing IDV3v2 tags. This structure is not a direct binary mapping with the file contents. The ID3v2 text frames are allowed to contain multiple strings. So check for null bytes until you reach the mpg123_string fill. All text is encoded in UTF-8.

Definition at line 908 of file mpg123.h.

Field Documentation

unsigned char mpg123_id3v2::version

3 or 4 for ID3v2.3 or ID3v2.4.

Definition at line 910 of file mpg123.h.

mpg123_string* mpg123_id3v2::title

Title string (pointer into text_list).

Definition at line 911 of file mpg123.h.

mpg123_string* mpg123_id3v2::artist

Artist string (pointer into text_list).

Definition at line 912 of file mpg123.h.

mpg123_string* mpg123_id3v2::album

Album string (pointer into text_list).

Definition at line 913 of file mpg123.h.

mpg123_string* mpg123_id3v2::year

The year as a string (pointer into text_list).

Definition at line 914 of file mpg123.h.

mpg123_string* mpg123_id3v2::genre

Genre String (pointer into text_list). The genre string(s) may very well need postprocessing, esp. for ID3v2.3.

Definition at line 915 of file mpg123.h.

mpg123_string* mpg123_id3v2::comment

Pointer to last encountered comment text with empty description.

Definition at line 916 of file mpg123.h.

mpg123_text* mpg123_id3v2::comment_list

Array of comments.

Definition at line 919 of file mpg123.h.

size_t mpg123_id3v2::comments

Number of comments.

Definition at line 920 of file mpg123.h.

mpg123_text* mpg123_id3v2::text

Array of ID3v2 text fields (including USLT)

Definition at line 921 of file mpg123.h.

size_t mpg123_id3v2::texts

Numer of text fields.

Definition at line 922 of file mpg123.h.

mpg123_text* mpg123_id3v2::extra

The array of extra (TXXX) fields.

Definition at line 923 of file mpg123.h.

size_t mpg123_id3v2::extras

Number of extra text (TXXX) fields.

Definition at line 924 of file mpg123.h.

The documentation for this struct was generated from the following file:

mpg123.h

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines