Medialib

Medialib caches metadata. More...

Macros
#define	XMMS_MEDIALIB_SOURCE_SERVER   "server"

Functions
xmms_medialib_t *	xmms_medialib_init (void)
	Initialize the medialib and open the database file.
s4_sourcepref_t *	xmms_medialib_get_source_preferences (xmms_medialib_t *medialib)
s4_t *	xmms_medialib_get_database_backend (xmms_medialib_t *medialib)
char *	xmms_medialib_uuid (xmms_medialib_t *medialib)
xmmsv_t *	xmms_medialib_entry_property_get_value (xmms_medialib_session_t *session, xmms_medialib_entry_t id_num, const gchar *property)
	Retrieve a property from an entry.
gchar *	xmms_medialib_entry_property_get_str (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property)
	Retrieve a property from an entry.
gint	xmms_medialib_entry_property_get_int (xmms_medialib_session_t *session, xmms_medialib_entry_t id_num, const gchar *property)
	Retrieve a property as a int from a entry.
gboolean	xmms_medialib_entry_property_set_int (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property, gint value)
	Set a entry property to a new value, overwriting the old value.
gboolean	xmms_medialib_entry_property_set_int_source (xmms_medialib_session_t *session, xmms_medialib_entry_t id_num, const gchar *property, gint value, const gchar *source)
gboolean	xmms_medialib_entry_property_set_str (xmms_medialib_session_t *session, xmms_medialib_entry_t entry, const gchar *property, const gchar *value)
	Set a entry property to a new value, overwriting the old value.
gboolean	xmms_medialib_entry_property_set_str_source (xmms_medialib_session_t *session, xmms_medialib_entry_t id_num, const gchar *property, const gchar *value, const gchar *source)
void	xmms_medialib_entry_remove (xmms_medialib_session_t *session, xmms_medialib_entry_t entry)
	Remove a medialib entry from the database.
void	xmms_medialib_entry_cleanup (xmms_medialib_session_t *session, xmms_medialib_entry_t entry)
xmmsv_t *	xmms_medialib_add_recursive (xmms_medialib_t *medialib, const gchar *path, xmms_error_t *error)
	Recursively add files under a path to the media library.
xmms_medialib_entry_t	xmms_medialib_entry_new_encoded (xmms_medialib_session_t *session, const gchar *url, xmms_error_t *error)
xmms_medialib_entry_t	xmms_medialib_entry_new (xmms_medialib_session_t *session, const char *url, xmms_error_t *error)
	Welcome to a function that should be called something else.

Detailed Description

Medialib caches metadata.

Controls metadata storage.

Macro Definition Documentation

XMMS_MEDIALIB_SOURCE_SERVER

#define XMMS_MEDIALIB_SOURCE_SERVER   "server"

Function Documentation

xmms_medialib_add_recursive()

xmmsv_t * xmms_medialib_add_recursive	(	xmms_medialib_t *	medialib,
		const gchar *	path,
		xmms_error_t *	error )

Recursively add files under a path to the media library.

Parameters

medialib	the medialib object
path	the directory to scan for files
error	If an error occurs, it will be stored in there.

Returns

an IDLIST collection with the added entries

xmms_medialib_entry_cleanup()

void xmms_medialib_entry_cleanup	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	entry )

xmms_medialib_entry_new()

xmms_medialib_entry_t xmms_medialib_entry_new	(	xmms_medialib_session_t *	session,
		const char *	url,
		xmms_error_t *	error )

Welcome to a function that should be called something else.

Returns a entry for a URL, if the URL is already in the medialib the current entry will be returned otherwise a new one will be created and returned.

Todo

rename to something better?

Parameters

url	URL to add/retrieve from the medialib
error	If an error occurs, it will be stored in there.

Returns

Entry mapped to the URL

xmms_medialib_entry_new_encoded()

xmms_medialib_entry_t xmms_medialib_entry_new_encoded	(	xmms_medialib_session_t *	session,
		const gchar *	url,
		xmms_error_t *	error )

Referenced by xmms_medialib_entry_new().

xmms_medialib_entry_property_get_int()

gint xmms_medialib_entry_property_get_int	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	id_num,
		const gchar *	property )

Retrieve a property as a int from a entry.

Parameters

id_num	Entry to query.
property	The property to extract. Strings passed should be defined in medialib.h

Returns

Property as integer, or -1 if it doesn't exist.

xmms_medialib_entry_property_get_str()

gchar * xmms_medialib_entry_property_get_str	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	entry,
		const gchar *	property )

Retrieve a property from an entry.

Parameters

entry	Entry to query.
property	The property to extract. Strings passed should be defined in medialib.h

Returns

Newly allocated gchar that needs to be freed with g_free

xmms_medialib_entry_property_get_value()

xmmsv_t * xmms_medialib_entry_property_get_value	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	id_num,
		const gchar *	property )

Retrieve a property from an entry.

See also

xmms_medialib_entry_property_get_str

Referenced by xmms_medialib_check_id().

xmms_medialib_entry_property_set_int()

gboolean xmms_medialib_entry_property_set_int	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	entry,
		const gchar *	property,
		gint	value )

Set a entry property to a new value, overwriting the old value.

Parameters

entry	Entry to alter.
property	The property to extract. Strings passed should be defined in medialib.h
value	gint with the new value, will be copied in to the medialib

Returns

TRUE on success and FALSE on failure.

Referenced by xmms_sample_converter_to_medialib().

xmms_medialib_entry_property_set_int_source()

gboolean xmms_medialib_entry_property_set_int_source	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	id_num,
		const gchar *	property,
		gint	value,
		const gchar *	source )

Referenced by xmms_medialib_entry_property_set_int().

xmms_medialib_entry_property_set_str()

gboolean xmms_medialib_entry_property_set_str	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	entry,
		const gchar *	property,
		const gchar *	value )

Set a entry property to a new value, overwriting the old value.

Parameters

entry	Entry to alter.
property	The property to extract. Strings passed should be defined in medialib.h
value	gchar with the new value, will be copied in to the medialib

Returns

TRUE on success and FALSE on failure.

Referenced by xmms_sample_converter_to_medialib().

xmms_medialib_entry_property_set_str_source()

gboolean xmms_medialib_entry_property_set_str_source	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	id_num,
		const gchar *	property,
		const gchar *	value,
		const gchar *	source )

Referenced by xmms_medialib_entry_property_set_str().

xmms_medialib_entry_remove()

void xmms_medialib_entry_remove	(	xmms_medialib_session_t *	session,
		xmms_medialib_entry_t	entry )

Remove a medialib entry from the database.

Parameters

id_num

Entry to remove

xmms_medialib_get_database_backend()

s4_t * xmms_medialib_get_database_backend

(

xmms_medialib_t *

medialib

)

xmms_medialib_get_source_preferences()

s4_sourcepref_t * xmms_medialib_get_source_preferences

(

xmms_medialib_t *

medialib

)

Referenced by xmms_medialib_session_get_source_preferences().

xmms_medialib_init()

xmms_medialib_t * xmms_medialib_init

(

void

)

Initialize the medialib and open the database file.

Returns

TRUE if successful and FALSE if there was a problem

Referenced by main().

xmms_medialib_uuid()

char * xmms_medialib_uuid

(

xmms_medialib_t *

medialib

)

Referenced by main().