libtaginfo_c  0.2.0
Data Structures | Macros | Enumerations | Functions
taginfo_c.h File Reference

Go to the source code of this file.

Data Structures

struct  TagInfo_Info
 
struct  TagInfo_Image
 

Macros

#define BOOL   int
 Boolean value as integer.
 

Enumerations

enum  TagInfo_MediaFileType {
  TAG_INFO_FILE_TYPE_UNKNOWN, TAG_INFO_FILE_TYPE_AAC, TAG_INFO_FILE_TYPE_AIF, TAG_INFO_FILE_TYPE_APE,
  TAG_INFO_FILE_TYPE_ASF, TAG_INFO_FILE_TYPE_FLAC, TAG_INFO_FILE_TYPE_M4A, TAG_INFO_FILE_TYPE_M4B,
  TAG_INFO_FILE_TYPE_M4P, TAG_INFO_FILE_TYPE_MP3, TAG_INFO_FILE_TYPE_MP4, TAG_INFO_FILE_TYPE_MPC,
  TAG_INFO_FILE_TYPE_OGA, TAG_INFO_FILE_TYPE_OGG, TAG_INFO_FILE_TYPE_TTA, TAG_INFO_FILE_TYPE_WAV,
  TAG_INFO_FILE_TYPE_WMA, TAG_INFO_FILE_TYPE_WV, TAG_INFO_FILE_TYPE_SPEEX, TAG_INFO_FILE_TYPE_WMV,
  TAG_INFO_FILE_TYPE_MOD, TAG_INFO_FILE_TYPE_IT, TAG_INFO_FILE_TYPE_XM, TAG_INFO_FILE_TYPE_S3M,
  TAG_INFO_FILE_TYPE_OPUS
}
 is an enumeration of media file types supported in libtaginfo More...
 
enum  TagInfo_ImageFileType {
  TAG_INFO_IMAGE_FILE_TYPE_UNKNOWN, TAG_INFO_IMAGE_FILE_TYPE_JPEG, TAG_INFO_IMAGE_FILE_TYPE_PNG, TAG_INFO_IMAGE_FILE_TYPE_GIF,
  TAG_INFO_IMAGE_FILE_TYPE_BMP
}
 is an enumeration of image file types for embedded images More...
 
enum  TagInfo_ImageContentType {
  TAG_INFO_IMAGE_CONTENT_OTHER, TAG_INFO_IMAGE_CONTENT_FILE_ICON, TAG_INFO_IMAGE_CONTENT_OTHER_FILE_ICON, TAG_INFO_IMAGE_CONTENT_COVER_FRONT,
  TAG_INFO_IMAGE_CONTENT_COVER_BACK, TAG_INFO_IMAGE_CONTENT_LEAFLET_PAGE, TAG_INFO_IMAGE_CONTENT_MEDIA, TAG_INFO_IMAGE_CONTENT_LEAD_ARTIST,
  TAG_INFO_IMAGE_CONTENT_ARTIST, TAG_INFO_IMAGE_CONTENT_CONDUCTOR, TAG_INFO_IMAGE_CONTENT_BAND, TAG_INFO_IMAGE_CONTENT_COMPOSER,
  TAG_INFO_IMAGE_CONTENT_LYRICIST, TAG_INFO_IMAGE_CONTENT_RECORDING_LOCATION, TAG_INFO_IMAGE_CONTENT_DURING_RECORDING, TAG_INFO_IMAGE_CONTENT_DURING_PERFORMANCE,
  TAG_INFO_IMAGE_CONTENT_MOVIESCREENCAPTURE, TAG_INFO_IMAGE_CONTENT_COLOURED_FISH, TAG_INFO_IMAGE_CONTENT_ILLUSTRATION, TAG_INFO_IMAGE_CONTENT_ARTIST_LOGO,
  TAG_INFO_IMAGE_CONTENT_PUBLISHER_LOGO
}
 enumeration for image content description More...
 

Functions

void taginfo_info_free (TagInfo_Info *info)
 
TagInfo_Infotaginfo_info_create (const char *filename)
 
TagInfo_Infotaginfo_info_create_with_file_type (const char *filename, TagInfo_MediaFileType format)
 
TagInfo_Infotaginfo_info_create_from_mime (const char *filename, const char *mime_type)
 
BOOL taginfo_info_is_valid (TagInfo_Info *info)
 
BOOL taginfo_info_load (TagInfo_Info *info)
 
BOOL taginfo_info_save (TagInfo_Info *info)
 
void taginfo_info_enable_string_management (BOOL management)
 Enable string management for libtaginfo.
 
void taginfo_info_free_strings ()
 
char * taginfo_info_get_album (const TagInfo_Info *info)
 
void taginfo_info_set_album (TagInfo_Info *info, const char *album)
 
char * taginfo_info_get_albumartist (const TagInfo_Info *info)
 
void taginfo_info_set_albumartist (TagInfo_Info *info, const char *albumartist)
 
char * taginfo_info_get_artist (const TagInfo_Info *info)
 Get the artist tag of a media track. More...
 
void taginfo_info_set_artist (TagInfo_Info *info, const char *artist)
 
int taginfo_info_get_beats_per_minute (const TagInfo_Info *info)
 Get the BPM of a media track. More...
 
void taginfo_info_set_beats_per_minute (TagInfo_Info *info, int new_bpm)
 Set the BPM of a media track. More...
 
char * taginfo_info_get_comment (const TagInfo_Info *info)
 
void taginfo_info_set_comment (TagInfo_Info *info, const char *comment)
 
char * taginfo_info_get_composer (const TagInfo_Info *info)
 
void taginfo_info_set_composer (TagInfo_Info *info, const char *composer)
 
char * taginfo_info_get_copyright (const TagInfo_Info *info)
 
void taginfo_info_set_copyright (TagInfo_Info *info, const char *copyright)
 
char * taginfo_info_get_encoder (const TagInfo_Info *info)
 
void taginfo_info_set_encoder (TagInfo_Info *info, const char *encoder)
 
char * taginfo_info_get_genre (const TagInfo_Info *info)
 
void taginfo_info_set_genre (TagInfo_Info *info, const char *genre)
 
BOOL taginfo_info_get_has_image (const TagInfo_Info *info)
 Get information on the availability of an image that is embedded in the media file. More...
 
char * taginfo_info_get_homepage (const TagInfo_Info *info)
 
void taginfo_info_set_homepage (TagInfo_Info *info, const char *homepage)
 
BOOL taginfo_info_get_is_compilation (const TagInfo_Info *info)
 Get the information if the media file is part of a compilation / VA album. More...
 
void taginfo_info_set_is_compilation (TagInfo_Info *info, BOOL is_compilation)
 Set the information if the media file is part of a compilation / VA album. More...
 
char * taginfo_info_get_original_artist (const TagInfo_Info *info)
 
void taginfo_info_set_original_artist (TagInfo_Info *info, const char *artist)
 
int taginfo_info_get_playcount (const TagInfo_Info *info)
 Get the play count of a media track. More...
 
void taginfo_info_set_playcount (TagInfo_Info *info, int count)
 Set the play count tag of a media track. More...
 
int taginfo_info_get_rating (const TagInfo_Info *info)
 Get the rating of a media track. rating 1 - 5; 0 -> not set. More...
 
void taginfo_info_set_rating (TagInfo_Info *info, int rating)
 Set the rating tag of a media track. rating 1 - 5; 0 -> not set. More...
 
char * taginfo_info_get_title (const TagInfo_Info *info)
 
void taginfo_info_set_title (TagInfo_Info *info, const char *title)
 
int taginfo_info_get_track_count (const TagInfo_Info *info)
 
void taginfo_info_set_track_count (TagInfo_Info *info, int track_number)
 
int taginfo_info_get_track_number (const TagInfo_Info *info)
 
void taginfo_info_set_track_number (TagInfo_Info *info, int track_number)
 
int taginfo_info_get_volume_count (const TagInfo_Info *info)
 Get the volume count of a media track. More...
 
void taginfo_info_set_volume_count (TagInfo_Info *info, int count)
 Set the volume count tag of a media track. More...
 
int taginfo_info_get_volume_number (const TagInfo_Info *info)
 Get the volume number of a media track. More...
 
void taginfo_info_set_volume_number (TagInfo_Info *info, int number)
 Set the volume number tag of a media track. More...
 
int taginfo_info_get_year (const TagInfo_Info *info)
 
void taginfo_info_set_year (TagInfo_Info *info, int year)
 
int taginfo_info_get_length (const TagInfo_Info *info)
 
int taginfo_info_get_bitrate (const TagInfo_Info *info)
 
int taginfo_info_get_samplerate (const TagInfo_Info *info)
 
int taginfo_info_get_channels (const TagInfo_Info *info)
 
char ** taginfo_info_get_track_labels (const TagInfo_Info *info, int *data_length)
 Get an array of user defined track labels. More...
 
void taginfo_info_set_track_labels (TagInfo_Info *info, const char *const *data, int data_length)
 Set an array of user defined track labels. More...
 
char ** taginfo_info_get_album_labels (const TagInfo_Info *info, int *data_length)
 Get an array of user defined album labels. More...
 
void taginfo_info_set_album_labels (TagInfo_Info *info, const char *const *data, int data_length)
 Set an array of user defined album labels. More...
 
char ** taginfo_info_get_artist_labels (const TagInfo_Info *info, int *data_length)
 Get an array of user defined artist labels. More...
 
void taginfo_info_set_artist_labels (TagInfo_Info *info, const char *const *data, int data_length)
 Set an array of user defined artist labels. More...
 
char * taginfo_info_get_lyrics (const TagInfo_Info *info)
 Get a lyrics string from the media file. More...
 
void taginfo_info_set_lyrics (TagInfo_Info *info, const char *lyrics)
 Set a lyrics string to the media file. More...
 
TagInfo_Image ** taginfo_info_get_images (const TagInfo_Info *info, int *image_count)
 Get an array of images copied from the file embedded images. More...
 
void taginfo_info_set_images (TagInfo_Info *info, TagInfo_Image **images, const int image_count)
 Set an array of TagInfo_Image to be embedded into the media file. More...
 
TagInfo_Imagetaginfo_image_new ()
 
void taginfo_image_free (TagInfo_Image *img)
 
void taginfo_image_array_free (TagInfo_Image **img_arr)
 
char * taginfo_image_get_data (const TagInfo_Image *img, unsigned int *bin_data_length)
 Get the binary data of the image. More...
 
void taginfo_image_set_data (TagInfo_Image *img, char *bin_data, unsigned int bin_data_length)
 Set the binary data of the image. More...
 
TagInfo_ImageContentType taginfo_image_get_content_type (const TagInfo_Image *img)
 Get the content's type of the image. More...
 
void taginfo_image_set_content_type (TagInfo_Image *img, TagInfo_ImageContentType itype)
 Set the content's type of the image. More...
 
TagInfo_ImageFileType taginfo_image_get_file_type (const TagInfo_Image *img)
 Get the file's type of the image. More...
 
void taginfo_image_set_file_type (TagInfo_Image *img, TagInfo_ImageFileType image_f_type)
 Set the file's type of the image. More...
 
char * taginfo_image_get_description (const TagInfo_Image *img)
 Get the file's type of the image. More...
 
void taginfo_image_set_description (TagInfo_Image *img, const char *new_description)
 Set the file's type of the image. More...
 

Enumeration Type Documentation

enumeration for image content description

Enumerator
TAG_INFO_IMAGE_CONTENT_OTHER 

An image type not listed here.

TAG_INFO_IMAGE_CONTENT_FILE_ICON 

32x32 PNG image that should be used as the file icon

TAG_INFO_IMAGE_CONTENT_OTHER_FILE_ICON 

File icon of a different size or format.

TAG_INFO_IMAGE_CONTENT_COVER_FRONT 

Front cover image of the album.

TAG_INFO_IMAGE_CONTENT_COVER_BACK 

Back cover image of the album.

TAG_INFO_IMAGE_CONTENT_LEAFLET_PAGE 

Inside leaflet page of the album.

TAG_INFO_IMAGE_CONTENT_MEDIA 

Image from the album itself.

TAG_INFO_IMAGE_CONTENT_LEAD_ARTIST 

Picture of the lead artist or soloist.

TAG_INFO_IMAGE_CONTENT_ARTIST 

Picture of the artist or performer.

TAG_INFO_IMAGE_CONTENT_CONDUCTOR 

Picture of the conductor.

TAG_INFO_IMAGE_CONTENT_BAND 

Picture of the band or orchestra.

TAG_INFO_IMAGE_CONTENT_COMPOSER 

Picture of the composer.

TAG_INFO_IMAGE_CONTENT_LYRICIST 

Picture of the lyricist or text writer.

TAG_INFO_IMAGE_CONTENT_RECORDING_LOCATION 

Picture of the recording location or studio.

TAG_INFO_IMAGE_CONTENT_DURING_RECORDING 

Picture of the artists during recording.

TAG_INFO_IMAGE_CONTENT_DURING_PERFORMANCE 

Picture of the artists during performance.

TAG_INFO_IMAGE_CONTENT_MOVIESCREENCAPTURE 

Picture from a movie or video related to the track.

TAG_INFO_IMAGE_CONTENT_COLOURED_FISH 

Picture of a large, coloured fish.

TAG_INFO_IMAGE_CONTENT_ILLUSTRATION 

Illustration related to the track.

TAG_INFO_IMAGE_CONTENT_ARTIST_LOGO 

Logo of the band or performer.

TAG_INFO_IMAGE_CONTENT_PUBLISHER_LOGO 

Logo of the publisher (record company)

Definition at line 195 of file taginfo_c.h.

is an enumeration of image file types for embedded images

Enumerator
TAG_INFO_IMAGE_FILE_TYPE_UNKNOWN 

Unknown image file type.

TAG_INFO_IMAGE_FILE_TYPE_JPEG 

Jpg file type.

TAG_INFO_IMAGE_FILE_TYPE_PNG 

Png file type.

TAG_INFO_IMAGE_FILE_TYPE_GIF 

Gif file type.

TAG_INFO_IMAGE_FILE_TYPE_BMP 

Bitmap file type.

Definition at line 180 of file taginfo_c.h.

is an enumeration of media file types supported in libtaginfo

Enumerator
TAG_INFO_FILE_TYPE_UNKNOWN 

Unknown media file type.

TAG_INFO_FILE_TYPE_AAC 

Aac media file.

TAG_INFO_FILE_TYPE_AIF 

Aiff media file.

TAG_INFO_FILE_TYPE_APE 

Ape media file.

TAG_INFO_FILE_TYPE_ASF 

Asf media file.

TAG_INFO_FILE_TYPE_FLAC 

Flac media file.

TAG_INFO_FILE_TYPE_M4A 

M4A media file.

TAG_INFO_FILE_TYPE_M4B 

M4B media file.

TAG_INFO_FILE_TYPE_M4P 

M4P media file.

TAG_INFO_FILE_TYPE_MP3 

MP3 media file.

TAG_INFO_FILE_TYPE_MP4 

MP4 media file.

TAG_INFO_FILE_TYPE_MPC 

MPC media file.

TAG_INFO_FILE_TYPE_OGA 

Oga media file.

TAG_INFO_FILE_TYPE_OGG 

Ogg media file.

TAG_INFO_FILE_TYPE_TTA 

Tta media file.

TAG_INFO_FILE_TYPE_WAV 

Wave media file.

TAG_INFO_FILE_TYPE_WMA 

Wma media file.

TAG_INFO_FILE_TYPE_WV 

WavPack media file.

TAG_INFO_FILE_TYPE_SPEEX 

Speex media file.

TAG_INFO_FILE_TYPE_WMV 

Wmv media file.

TAG_INFO_FILE_TYPE_MOD 

Mod media file.

TAG_INFO_FILE_TYPE_IT 

Impulse Tracker media file.

TAG_INFO_FILE_TYPE_XM 

Xm media file.

TAG_INFO_FILE_TYPE_S3M 

S3m media file.

TAG_INFO_FILE_TYPE_OPUS 

Opus media file.

Definition at line 125 of file taginfo_c.h.

Function Documentation

void taginfo_image_array_free ( TagInfo_Image **  img_arr)

Frees an array of TagInfo_Image as returned from taginfo_info_get_images()..

Parameters
img_arrAn array of TagInfo_Image

Definition at line 894 of file taginfo_c.cc.

void taginfo_image_free ( TagInfo_Image img)

Frees a TagInfo_Image object.

Parameters
imgA TagInfo_Image object

Definition at line 882 of file taginfo_c.cc.

TagInfo_ImageContentType taginfo_image_get_content_type ( const TagInfo_Image img)

Get the content's type of the image.

Parameters
imgA TagInfo_Image object
Returns
image type as TagInfo_ImageContentType

Definition at line 806 of file taginfo_c.cc.

References TAG_INFO_IMAGE_CONTENT_OTHER.

char* taginfo_image_get_data ( const TagInfo_Image img,
unsigned int *  bin_data_length 
)

Get the binary data of the image.

Parameters
imgA TagInfo_Image object
bin_data_lengthThe return location for the length of the returned array.
Returns
Array of bytes

Definition at line 781 of file taginfo_c.cc.

char* taginfo_image_get_description ( const TagInfo_Image img)

Get the file's type of the image.

Parameters
imgA TagInfo_Image object
Returns
description as char*

Definition at line 854 of file taginfo_c.cc.

TagInfo_ImageFileType taginfo_image_get_file_type ( const TagInfo_Image img)

Get the file's type of the image.

Parameters
imgA TagInfo_Image object
Returns
image type as TagInfo_ImageFileType

Definition at line 830 of file taginfo_c.cc.

References TAG_INFO_IMAGE_FILE_TYPE_UNKNOWN.

TagInfo_Image* taginfo_image_new ( )

Constructor function for new TagInfo_Image

Returns
Newly created TagInfo_Image

Definition at line 770 of file taginfo_c.cc.

void taginfo_image_set_content_type ( TagInfo_Image img,
TagInfo_ImageContentType  itype 
)

Set the content's type of the image.

Parameters
imgA TagInfo_Image object
itypeimage type as TagInfo_ImageContentType

Definition at line 818 of file taginfo_c.cc.

void taginfo_image_set_data ( TagInfo_Image img,
char *  bin_data,
unsigned int  bin_data_length 
)

Set the binary data of the image.

Parameters
imgA TagInfo_Image object
bin_dataArray of bytes
bin_data_lengthThe length of the data array.

Definition at line 794 of file taginfo_c.cc.

void taginfo_image_set_description ( TagInfo_Image img,
const char *  new_description 
)

Set the file's type of the image.

Parameters
imgA TagInfo_Image object
new_descriptionas const char*. Will be copied internally

Definition at line 866 of file taginfo_c.cc.

void taginfo_image_set_file_type ( TagInfo_Image img,
TagInfo_ImageFileType  image_f_type 
)

Set the file's type of the image.

Parameters
imgA TagInfo_Image object
image_f_typeimage type as TagInfo_ImageFileType

Definition at line 842 of file taginfo_c.cc.

TagInfo_Info* taginfo_info_create ( const char *  filename)

Creates a TagInfo_Info object based on filename. TagInfo will try to guess the file type.

Returns
NULL if the file type cannot be determined or the file cannot be opened. The returned object should be freed with taginfo_info_free() after usage

Definition at line 98 of file taginfo_c.cc.

TagInfo_Info* taginfo_info_create_from_mime ( const char *  filename,
const char *  mime_type 
)

Creates a TagInfo_Info object based on filename and mimetype

Returns
NULL if the file type cannot be determined or the file cannot be opened. The returned object should be freed with taginfo_info_free() after usage

Definition at line 121 of file taginfo_c.cc.

TagInfo_Info* taginfo_info_create_with_file_type ( const char *  filename,
TagInfo_MediaFileType  media_file_type 
)

Creates a TagInfo_Info object based on filename and TagInfo_MediaFileType

Returns
NULL if the file type cannot be determined or the file cannot be opened. The returned object should be freed with taginfo_info_free() after usage

Definition at line 108 of file taginfo_c.cc.

void taginfo_info_free ( TagInfo_Info info)

Frees a TagInfo_Info object.

Parameters
infoA TagInfo_Info object

Definition at line 138 of file taginfo_c.cc.

void taginfo_info_free_strings ( )

Clean up used strings To be used in case string management is used

Definition at line 51 of file taginfo_c.cc.

char* taginfo_info_get_album ( const TagInfo_Info info)

Get the album of a media track.

Parameters
infoA TagInfo_Info object
Returns
The album as char *. In case the string management is not enabled, the caller should free this string

Definition at line 209 of file taginfo_c.cc.

char** taginfo_info_get_album_labels ( const TagInfo_Info info,
int *  labels_length 
)

Get an array of user defined album labels.

Parameters
infoA TagInfo_Info object
Returns
Array of album labels
Parameters
labels_lengthThe return location for the length of the returned array.

Definition at line 666 of file taginfo_c.cc.

char* taginfo_info_get_albumartist ( const TagInfo_Info info)

Get the albumartist tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The albumartist as char *. In case the string management is not enabled, the caller should free this string

Definition at line 255 of file taginfo_c.cc.

char* taginfo_info_get_artist ( const TagInfo_Info info)

Get the artist tag of a media track.

Returns
The artist as char *. In case the string management is not enabled, the caller should free this string
Parameters
infoA TagInfo_Info object

Definition at line 163 of file taginfo_c.cc.

char** taginfo_info_get_artist_labels ( const TagInfo_Info info,
int *  labels_length 
)

Get an array of user defined artist labels.

Parameters
infoA TagInfo_Info object
Returns
Array of artist labels
Parameters
labels_lengthThe return location for the length of the returned array.

Definition at line 691 of file taginfo_c.cc.

int taginfo_info_get_beats_per_minute ( const TagInfo_Info info)

Get the BPM of a media track.

Parameters
infoA TagInfo_Info object
Returns
The BPM as int.

Definition at line 544 of file taginfo_c.cc.

int taginfo_info_get_bitrate ( const TagInfo_Info info)

Get the bitrate audio property

Parameters
infoA TagInfo_Info object
Returns
The bitrate as int.

Definition at line 473 of file taginfo_c.cc.

int taginfo_info_get_channels ( const TagInfo_Info info)

Get the channels audio property

Parameters
infoA TagInfo_Info object
Returns
The number of channels as int.

Definition at line 493 of file taginfo_c.cc.

char* taginfo_info_get_comment ( const TagInfo_Info info)

Get the comment tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The comment as char *. In case the string management is not enabled, the caller should free this string

Definition at line 278 of file taginfo_c.cc.

char* taginfo_info_get_composer ( const TagInfo_Info info)

Get the composer tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The composer as char *. In case the string management is not enabled, the caller should free this string

Definition at line 301 of file taginfo_c.cc.

char* taginfo_info_get_copyright ( const TagInfo_Info info)

Get the copyright tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The copyright as char *. In case the string management is not enabled, the caller should free this string

Definition at line 370 of file taginfo_c.cc.

char* taginfo_info_get_encoder ( const TagInfo_Info info)

Get the encoder tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The encoder as char *. In case the string management is not enabled, the caller should free this string

Definition at line 347 of file taginfo_c.cc.

char* taginfo_info_get_genre ( const TagInfo_Info info)

Get the genre tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The genre as char *. In case the string management is not enabled, the caller should free this string

Definition at line 393 of file taginfo_c.cc.

BOOL taginfo_info_get_has_image ( const TagInfo_Info info)

Get information on the availability of an image that is embedded in the media file.

Parameters
infoA TagInfo_Info object
Returns
TRUE if there is an image

Definition at line 513 of file taginfo_c.cc.

char* taginfo_info_get_homepage ( const TagInfo_Info info)

Get the homepage tag of a media track.

Parameters
infoA TagInfo_Info object
Returns
The homepage as char *. In case the string management is not enabled, the caller should free this string

Definition at line 324 of file taginfo_c.cc.

TagInfo_Image** taginfo_info_get_images ( const TagInfo_Info info,
int *  image_count 
)

Get an array of images copied from the file embedded images.

Returns
Array of TagInfo_Image
Parameters
infoA TagInfo_Info object
image_countThe return location for the length of the returned array.

Definition at line 736 of file taginfo_c.cc.

BOOL taginfo_info_get_is_compilation ( const TagInfo_Info info)

Get the information if the media file is part of a compilation / VA album.

Parameters
infoA TagInfo_Info object
Returns
TRUE if it is part of a compilation

Definition at line 620 of file taginfo_c.cc.

References BOOL.

int taginfo_info_get_length ( const TagInfo_Info info)

Get the length audio property

Parameters
infoA TagInfo_Info object
Returns
The length in seconds as int.

Definition at line 503 of file taginfo_c.cc.

char* taginfo_info_get_lyrics ( const TagInfo_Info info)

Get a lyrics string from the media file.

Returns
Lyrics string
Parameters
infoA TagInfo_Info object

Definition at line 911 of file taginfo_c.cc.

char* taginfo_info_get_original_artist ( const TagInfo_Info info)

Get the original artist of a media track.

Parameters
infoA TagInfo_Info object
Returns
The original artist as char *. In case the string management is not enabled, the caller should free this string

Definition at line 186 of file taginfo_c.cc.

int taginfo_info_get_playcount ( const TagInfo_Info info)

Get the play count of a media track.

Parameters
infoA TagInfo_Info object
Returns
The play count as int.

Definition at line 601 of file taginfo_c.cc.

int taginfo_info_get_rating ( const TagInfo_Info info)

Get the rating of a media track. rating 1 - 5; 0 -> not set.

Parameters
infoA TagInfo_Info object
Returns
The rating as int.

Definition at line 582 of file taginfo_c.cc.

int taginfo_info_get_samplerate ( const TagInfo_Info info)

Get the samplerate audio property

Parameters
infoA TagInfo_Info object
Returns
The samplerate as int.

Definition at line 483 of file taginfo_c.cc.

char* taginfo_info_get_title ( const TagInfo_Info info)

Get the title of a media track.

Parameters
infoA TagInfo_Info object
Returns
The title as char *. In case the string management is not enabled, the caller should free this string

Definition at line 232 of file taginfo_c.cc.

int taginfo_info_get_track_count ( const TagInfo_Info info)

Get the track count of a media track.

Parameters
infoA TagInfo_Info object
Returns
The track count as int.

Definition at line 435 of file taginfo_c.cc.

char** taginfo_info_get_track_labels ( const TagInfo_Info info,
int *  labels_length 
)

Get an array of user defined track labels.

Parameters
infoA TagInfo_Info object
Returns
Array of track labels
Parameters
labels_lengthThe return location for the length of the returned array.

Definition at line 641 of file taginfo_c.cc.

int taginfo_info_get_track_number ( const TagInfo_Info info)

Get the track number of a media track.

Parameters
infoA TagInfo_Info object
Returns
The track number as int.

Definition at line 416 of file taginfo_c.cc.

int taginfo_info_get_volume_count ( const TagInfo_Info info)

Get the volume count of a media track.

Parameters
infoA TagInfo_Info object
Returns
The volume_count as int.

Definition at line 563 of file taginfo_c.cc.

int taginfo_info_get_volume_number ( const TagInfo_Info info)

Get the volume number of a media track.

Parameters
infoA TagInfo_Info object
Returns
The volume number as int.

Definition at line 524 of file taginfo_c.cc.

int taginfo_info_get_year ( const TagInfo_Info info)

Get the publishing year of a media track.

Parameters
infoA TagInfo_Info object
Returns
The year as int.

Definition at line 454 of file taginfo_c.cc.

BOOL taginfo_info_load ( TagInfo_Info info)

Load the tag information from the media file to the TagInfo_Info object

Parameters
infoA TagInfo_Info object

Definition at line 147 of file taginfo_c.cc.

BOOL taginfo_info_save ( TagInfo_Info info)

Save the tag information from the TagInfo_Info object to the media file.

Parameters
infoA TagInfo_Info object

Definition at line 153 of file taginfo_c.cc.

void taginfo_info_set_album ( TagInfo_Info info,
const char *  album 
)

Set the album of a media track.

Parameters
infoA TagInfo_Info object
albumAlbum as const char *.

Definition at line 222 of file taginfo_c.cc.

void taginfo_info_set_album_labels ( TagInfo_Info info,
const char *const *  labels,
int  labels_length 
)

Set an array of user defined album labels.

Parameters
infoA TagInfo_Info object
labelsAn array of user defined album labels
labels_lengthThe length of the array

Definition at line 678 of file taginfo_c.cc.

void taginfo_info_set_albumartist ( TagInfo_Info info,
const char *  albumartist 
)

Set the album artist tag of a media track.

Parameters
infoA TagInfo_Info object
albumartistAlbum artist as const char *.

Definition at line 268 of file taginfo_c.cc.

void taginfo_info_set_artist ( TagInfo_Info info,
const char *  artist 
)

Set the artist tag of a media track.

Parameters
infoA TagInfo_Info object
artistArtist as const char *.

Definition at line 176 of file taginfo_c.cc.

void taginfo_info_set_artist_labels ( TagInfo_Info info,
const char *const *  labels,
int  labels_length 
)

Set an array of user defined artist labels.

Parameters
infoA TagInfo_Info object
labelsAn array of user defined artist labels
labels_lengthThe length of the array

Definition at line 703 of file taginfo_c.cc.

void taginfo_info_set_beats_per_minute ( TagInfo_Info info,
int  new_bpm 
)

Set the BPM of a media track.

Parameters
infoA TagInfo_Info object
new_bpmBPM as int.

Definition at line 553 of file taginfo_c.cc.

void taginfo_info_set_comment ( TagInfo_Info info,
const char *  comment 
)

Set the comment of a media track.

Parameters
infoA TagInfo_Info object
commentComment as const char *.

Definition at line 291 of file taginfo_c.cc.

void taginfo_info_set_composer ( TagInfo_Info info,
const char *  composer 
)

Set the composer of a media track.

Parameters
infoA TagInfo_Info object
composerComposer as const char *.

Definition at line 314 of file taginfo_c.cc.

void taginfo_info_set_copyright ( TagInfo_Info info,
const char *  copyright 
)

Set the copyright tag of a media track.

Parameters
infoA TagInfo_Info object
copyrightCopyright tag as const char *.

Definition at line 383 of file taginfo_c.cc.

void taginfo_info_set_encoder ( TagInfo_Info info,
const char *  encoder 
)

Set the encoder of a media track.

Parameters
infoA TagInfo_Info object
encoderEncoder tag as const char *.

Definition at line 360 of file taginfo_c.cc.

void taginfo_info_set_genre ( TagInfo_Info info,
const char *  genre 
)

Set the genre tag of a media track.

Parameters
infoA TagInfo_Info object
genreGenre tag as const char *.

Definition at line 406 of file taginfo_c.cc.

void taginfo_info_set_homepage ( TagInfo_Info info,
const char *  homepage 
)

Set the homepage tag of a media track.

Parameters
infoA TagInfo_Info object
homepageHomepage tag as const char *.

Definition at line 337 of file taginfo_c.cc.

void taginfo_info_set_images ( TagInfo_Info info,
TagInfo_Image **  images,
const int  image_count 
)

Set an array of TagInfo_Image to be embedded into the media file.

Parameters
infoA TagInfo_Info object
imagesAn array of TagInfo_Image
image_countThe length of the TagInfo_Image array

Definition at line 761 of file taginfo_c.cc.

void taginfo_info_set_is_compilation ( TagInfo_Info info,
BOOL  is_compilation 
)

Set the information if the media file is part of a compilation / VA album.

Parameters
infoA TagInfo_Info object
is_compilationTRUE if it is part of a compilation

Definition at line 630 of file taginfo_c.cc.

void taginfo_info_set_lyrics ( TagInfo_Info info,
const char *  lyrics 
)

Set a lyrics string to the media file.

Parameters
lyricsLyrics string
infoA TagInfo_Info object

Definition at line 925 of file taginfo_c.cc.

void taginfo_info_set_original_artist ( TagInfo_Info info,
const char *  artist 
)

Set the original artist of a media track.

Parameters
infoA TagInfo_Info object
artistOriginal artist as const char *.

Definition at line 199 of file taginfo_c.cc.

void taginfo_info_set_playcount ( TagInfo_Info info,
int  count 
)

Set the play count tag of a media track.

Parameters
infoA TagInfo_Info object
countPlay count tag as int.

Definition at line 610 of file taginfo_c.cc.

void taginfo_info_set_rating ( TagInfo_Info info,
int  rating 
)

Set the rating tag of a media track. rating 1 - 5; 0 -> not set.

Parameters
infoA TagInfo_Info object
ratingRating as int.

Definition at line 591 of file taginfo_c.cc.

void taginfo_info_set_title ( TagInfo_Info info,
const char *  title 
)

Set the title of a media track.

Parameters
infoA TagInfo_Info object
titleTitle as const char *.

Definition at line 245 of file taginfo_c.cc.

void taginfo_info_set_track_count ( TagInfo_Info info,
int  track_count 
)

Set the track count tag of a media track.

Parameters
infoA TagInfo_Info object
track_countTrack count tag as int.

Definition at line 444 of file taginfo_c.cc.

void taginfo_info_set_track_labels ( TagInfo_Info info,
const char *const *  labels,
int  labels_length 
)

Set an array of user defined track labels.

Parameters
infoA TagInfo_Info object
labelsAn array of user defined track labels
labels_lengthThe length of the array

Definition at line 653 of file taginfo_c.cc.

void taginfo_info_set_track_number ( TagInfo_Info info,
int  track_number 
)

Set the track number tag of a media track.

Parameters
infoA TagInfo_Info object
track_numberTrack number tag as int.

Definition at line 425 of file taginfo_c.cc.

void taginfo_info_set_volume_count ( TagInfo_Info info,
int  count 
)

Set the volume count tag of a media track.

Parameters
infoA TagInfo_Info object
countVolume count tag as int.

Definition at line 572 of file taginfo_c.cc.

void taginfo_info_set_volume_number ( TagInfo_Info info,
int  number 
)

Set the volume number tag of a media track.

Parameters
infoA TagInfo_Info object
numberVolume number tag as int.

Definition at line 533 of file taginfo_c.cc.

void taginfo_info_set_year ( TagInfo_Info info,
int  year 
)

Set the year tag of a media track.

Parameters
infoA TagInfo_Info object
yearYear tag as int.

Definition at line 463 of file taginfo_c.cc.