libmpd-database.h File Reference

Go to the source code of this file.

Typedefs
typedef mpd_SearchStats	MpdDBStats
	A Structure containing numberOfSongs and playTime.

Functions
MpdData *	mpd_database_get_albums (MpdObj *mi, const char *artist)
MpdData *	mpd_database_get_artists (MpdObj *mi)
MpdData *	mpd_database_get_complete (MpdObj *mi)
int	mpd_database_update_dir (MpdObj *mi, const char *path)
MpdData *	mpd_database_find (MpdObj *mi, int table, const char *string, int exact)
MpdData *	mpd_database_get_directory (MpdObj *mi, const char *path)
MpdData *	mpd_database_get_directory_recursive (MpdObj *mi, const char *path)
mpd_Song *	mpd_database_get_fileinfo (MpdObj *mi, const char *path)
void	mpd_database_search_add_constraint (MpdObj *mi, mpd_TagItems field, const char *value)
void	mpd_database_search_start (MpdObj *mi, int exact)
void	mpd_database_search_field_start (MpdObj *mi, mpd_TagItems field)
MpdData *	mpd_database_search_commit (MpdObj *mi)
void	mpd_database_search_stats_start (MpdObj *mi)
MpdDBStats *	mpd_database_search_stats_commit (MpdObj *mi)
void	mpd_database_search_free_stats (MpdDBStats *data)
int	mpd_database_delete_playlist (MpdObj *mi, const char *path)
int	mpd_database_save_playlist (MpdObj *mi, const char *name)
MpdData *	mpd_database_get_playlist_content (MpdObj *mi, const char *playlist)
void	mpd_database_playlist_list_add (MpdObj *mi, const char *path, const char *file)
void	mpd_database_playlist_list_delete (MpdObj *mi, const char *path, int pos)
void	mpd_database_playlist_clear (MpdObj *mi, const char *path)
void	mpd_database_playlist_rename (MpdObj *mi, const char *old_name, const char *new_name)
int	mpd_database_playlist_move (MpdObj *mi, const char *playlist, int old_pos, int new_pos)
MpdData *	mpd_database_playlist_list (MpdObj *mi)

Typedef Documentation

MpdDBStats

typedef mpd_SearchStats MpdDBStats

A Structure containing numberOfSongs and playTime.

see mpd_SearchStats

Definition at line 207 of file libmpd-database.h.

Function Documentation

mpd_database_delete_playlist()

int mpd_database_delete_playlist	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	A MpdObj
path	path of the playlist

Deletes a playlist.

Returns

a MpdError

References mpd_database_delete_playlist().

Referenced by mpd_database_delete_playlist().

mpd_database_find()

MpdData * mpd_database_find	(	MpdObj *	mi,
		int	table,
		const char *	string,
		int	exact )

Parameters

mi	a MpdObj
table	table
string	string to search for
exact	if TRUE only return exact matches WARNING: This function is deprecated, use mpd_database_search_start

Returns

a MpdData list

References mpd_database_find().

Referenced by mpd_database_find().

mpd_database_get_albums()

MpdData * mpd_database_get_albums	(	MpdObj *	mi,
		const char *	artist )

Parameters

mi	A MpdObj
artist	an artist name

Grabs a list of albums of a certain artist from mpd. if artist is NULL it grabs all albums

Returns

A MpdData list.

References mpd_database_get_albums().

Referenced by mpd_database_get_albums().

mpd_database_get_artists()

MpdData * mpd_database_get_artists

(

MpdObj *

mi

)

Parameters

mi

a MpdObj

returns a list of all available artists.

Returns

a MpdData list

References mpd_database_get_artists().

Referenced by mpd_database_get_artists().

mpd_database_get_complete()

MpdData * mpd_database_get_complete

(

MpdObj *

mi

)

Parameters

mi

a MpdObj

Gets the complete database, only returns songs

Returns

a MpdData list with songs

References mpd_database_get_complete().

Referenced by mpd_database_get_complete().

mpd_database_get_directory()

MpdData * mpd_database_get_directory	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	a MpdObj
path	a NULL terminated path string

Gets the contents of a directory, it can return songs, directories and playlists

Returns

a MpdData list with songs, directories and playlists

References mpd_database_get_directory().

Referenced by mpd_database_get_directory().

mpd_database_get_directory_recursive()

MpdData * mpd_database_get_directory_recursive	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	a MpdObj
path	a string containing the path

Recursively list all the songs directory path

Returns

a MpdData

References mpd_database_get_directory_recursive().

Referenced by mpd_database_get_directory_recursive().

mpd_database_get_fileinfo()

mpd_Song * mpd_database_get_fileinfo	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	A MpdObj
path	an Path to a file

Grabs the song info for a single file. Make sure you pass a url to a song and not a directory, that might result in strange behaviour.

Returns

a mpd_Song

References mpd_database_get_fileinfo().

Referenced by mpd_database_get_fileinfo().

mpd_database_get_playlist_content()

MpdData * mpd_database_get_playlist_content	(	MpdObj *	mi,
		const char *	playlist )

Parameters

mi	a MpdObj
playlist	the playlist you need the content of.

Needs mpd 0.12.0 or higher.

Returns

a MpdData list

References mpd_database_get_playlist_content().

Referenced by mpd_database_get_playlist_content().

mpd_database_playlist_clear()

void mpd_database_playlist_clear	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	a MpdObj
path	a string containing the path of the playlist

Clears the content of a stored playlist, also used to create an empty playlist Needs mpd 0.13.0

References mpd_database_playlist_clear().

Referenced by mpd_database_playlist_clear().

mpd_database_playlist_list()

MpdData * mpd_database_playlist_list

(

MpdObj *

mi

)

References mpd_database_playlist_list().

Referenced by mpd_database_playlist_list().

mpd_database_playlist_list_add()

void mpd_database_playlist_list_add	(	MpdObj *	mi,
		const char *	path,
		const char *	file )

Parameters

mi	a MpdObj
path	a string contains the path of the playlist
file	a string contains the path of the song to add

Add a path to a stored playlist. Needs 0.13.0

References mpd_database_playlist_list_add().

Referenced by mpd_database_playlist_list_add().

mpd_database_playlist_list_delete()

void mpd_database_playlist_list_delete	(	MpdObj *	mi,
		const char *	path,
		int	pos )

Parameters

mi	a MpdObj
path	a string containing the path of the playlist
pos	an int representing the position of a song

Deletes the song at position pos from a playlist. Needs mpd 0.13.0

References mpd_database_playlist_list_delete().

Referenced by mpd_database_playlist_list_delete().

mpd_database_playlist_move()

int mpd_database_playlist_move	(	MpdObj *	mi,
		const char *	playlist,
		int	old_pos,
		int	new_pos )

Parameters

mi	a MpdObj
playlist	a string containing the path of the playlist
old_pos	an integer representing old position
new_pos	an integer representing the position to move old_pos to.

Moves songs in a stored playlist Needs mpd 0.13.0

References mpd_database_playlist_move().

Referenced by mpd_database_playlist_move().

mpd_database_playlist_rename()

void mpd_database_playlist_rename	(	MpdObj *	mi,
		const char *	old_name,
		const char *	new_name )

Parameters

mi	a MpdObj
old	a string, old playlist name
new	a string, new playlist name

Renames a stored playlist Needs mpd 0.13.0

References mpd_database_playlist_rename().

Referenced by mpd_database_playlist_rename().

mpd_database_save_playlist()

int mpd_database_save_playlist	(	MpdObj *	mi,
		const char *	name )

Parameters

mi	a MpdObj
name	The name of the playlist

Saves the current playlist to a file.

Returns

a MpdError. MPD_OK if successful, MPD_DATABASE_PLAYLIST_EXIST when the playlist already exists.

References mpd_database_save_playlist().

Referenced by mpd_database_save_playlist().

mpd_database_search_add_constraint()

void mpd_database_search_add_constraint	(	MpdObj *	mi,
		mpd_TagItems	field,
		const char *	value )

Parameters

mi	A MpdObj
field	A mpd_TagItems
value	a string that field needs to match

Adds a constraint to the search

References mpd_database_search_add_constraint().

Referenced by mpd_database_search_add_constraint().

mpd_database_search_commit()

MpdData * mpd_database_search_commit

(

MpdObj *

mi

)

Parameters

mi

A MpdObj

Commits the search and gathers the result in a MpdData list.

Returns

a MpdData list with the search result, or NULL when nothing is found

References mpd_database_search_commit().

Referenced by mpd_database_search_commit().

mpd_database_search_field_start()

void mpd_database_search_field_start	(	MpdObj *	mi,
		mpd_TagItems	field )

Parameters

mi	a MpdObj
field	a mpd_TagItems

Starts a field search, eg. if you want a list of all albums, you do;

mpd_database_search_field_start(mi, MPD_TAG_ITEM_ALBUM);
data = mpd_database_search_commit(mi);

You can add constraints using mpd_database_search_add_constraint, for example if you want all albums by eric clapton:

mpd_database_search_field_start(mi, MPD_TAG_ITEM_ALBUM);
mpd_database_search_add_constraint(mi, MPD_TAG_ITEM_ARTIST, "Eric Clapton");
data = mpd_database_search_commit(mi);

References mpd_database_search_field_start().

Referenced by mpd_database_search_field_start().

mpd_database_search_free_stats()

void mpd_database_search_free_stats

(

MpdDBStats *

data

)

Parameters

data	a MpdDBStats

frees the MpdDBStats structure.

References mpd_database_search_free_stats().

Referenced by mpd_database_search_free_stats().

mpd_database_search_start()

void mpd_database_search_start	(	MpdObj *	mi,
		int	exact )

Parameters

mi	A MpdObj
exact	a boolean indicating if the search is fuzzy or exact

Starts a search, you can add "constraints" by calling mpd_database_search_add_constraint For Example if you want all songs by Eric Clapton you could do:

mpd_database_search_start(mi, TRUE);
mpd_database_search_add_constraint(mi, MPD_TAG_ITEM_ARTIST, "Eric Clapton");
data= mpd_database_search_commit(mi);

If you only want the songs from the album unplugged:

mpd_database_search_start(mi, TRUE);
mpd_database_search_add_constraint(mi, MPD_TAG_ITEM_ARTIST, "Eric Clapton");
mpd_database_search_add_constraint(mi, MPD_TAG_ITEM_ALBUM, "Unplugged");
data= mpd_database_search_commit(mi);

This function requires mpd 0.12.0 or higher

References mpd_database_search_start().

Referenced by mpd_database_search_start().

mpd_database_search_stats_commit()

MpdDBStats * mpd_database_search_stats_commit

(

MpdObj *

mi

)

Parameters

mi

A MpdObj

Gets statistics results of a search.

Returns

a MpdDBStats

References mpd_database_search_stats_commit().

Referenced by mpd_database_search_stats_commit().

mpd_database_search_stats_start()

void mpd_database_search_stats_start

(

MpdObj *

mi

)

Parameters

mi

A MpdObj

Starts a search, you can add constraints by calling mpd_database_search_add_constraint. To get the result call mpd_database_search_stats_commit

This function requires mpd 0.13.0 or higher

References mpd_database_search_stats_start().

Referenced by mpd_database_search_stats_start().

mpd_database_update_dir()

int mpd_database_update_dir	(	MpdObj *	mi,
		const char *	path )

Parameters

mi	A MpdObj
path	The path mpd should update.

Force mpd to update (parts of) the database.

Returns

a MpdError

References mpd_database_update_dir().

Referenced by mpd_database_update_dir().