MedialibControl

This controls the medialib. More...

Functions
xmmsc_result_t *	xmmsc_medialib_get_id (xmmsc_connection_t *conn, const char *url)
	Search for a entry (URL) in the medialib db and return its ID number. More...
xmmsc_result_t *	xmmsc_medialib_get_id_encoded (xmmsc_connection_t *conn, const char *url)
	Search for a entry (URL) in the medialib db and return its ID number. More...
xmmsc_result_t *	xmmsc_medialib_move_entry (xmmsc_connection_t *conn, int entry, const char *url)
	Change the url property of an entry in the media library. More...
xmmsc_result_t *	xmmsc_medialib_remove_entry (xmmsc_connection_t *conn, int entry)
	Remove a entry from the medialib. More...
xmmsc_result_t *	xmmsc_medialib_add_entry (xmmsc_connection_t *conn, const char *url)
	Add a URL to the medialib. More...
xmmsc_result_t *	xmmsc_medialib_add_entry_args (xmmsc_connection_t *conn, const char *url, int numargs, const char **args)
	Add a URL with arguments to the medialib. More...
xmmsc_result_t *	xmmsc_medialib_add_entry_full (xmmsc_connection_t *conn, const char *url, xmmsv_t *args)
	Add a URL with arguments to the medialib. More...
xmmsc_result_t *	xmmsc_medialib_add_entry_encoded (xmmsc_connection_t *conn, const char *url)
	Add a URL to the medialib. More...
xmmsc_result_t *	xmmsc_medialib_import_path (xmmsc_connection_t *conn, const char *path)
	Import a all files recursivly from the directory passed as argument. More...
xmmsc_result_t *	xmmsc_medialib_import_path_encoded (xmmsc_connection_t *conn, const char *path)
	Import a all files recursivly from the directory passed as argument which must already be url encoded. More...
xmmsc_result_t *	xmmsc_medialib_path_import (xmmsc_connection_t *conn, const char *path)
	Import a all files recursivly from the directory passed as argument. More...
xmmsc_result_t *	xmmsc_medialib_path_import_encoded (xmmsc_connection_t *conn, const char *path)
	Import a all files recursivly from the directory passed as argument which must already be url encoded. More...
xmmsc_result_t *	xmmsc_medialib_rehash (xmmsc_connection_t *conn, int id)
	Rehash the medialib, this will check data in the medialib still is the same as the data in files. More...
xmmsc_result_t *	xmmsc_medialib_get_info (xmmsc_connection_t *c, int id)
	Retrieve information about a entry from the medialib. More...
xmmsc_result_t *	xmmsc_broadcast_medialib_entry_added (xmmsc_connection_t *c)
	Request the medialib_entry_added broadcast. More...
xmmsc_result_t *	xmmsc_broadcast_medialib_entry_changed (xmmsc_connection_t *c)
	Request the medialib_entry_updated broadcast. More...
xmmsc_result_t *	xmmsc_broadcast_medialib_entry_updated (xmmsc_connection_t *c)
	Request the medialib_entry_updated broadcast. More...
xmmsc_result_t *	xmmsc_broadcast_medialib_entry_removed (xmmsc_connection_t *c)
	Request the medialib_entry_removed broadcast. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_set_int (xmmsc_connection_t *c, int id, const char *key, int32_t value)
	Associate a int value with a medialib entry. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_set_int_with_source (xmmsc_connection_t *c, int id, const char *source, const char *key, int32_t value)
	Set a custom int field in the medialib associated with a entry, the same as xmmsc_medialib_entry_property_set_int but with specifing your own source. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_set_str (xmmsc_connection_t *c, int id, const char *key, const char *value)
	Associate a value with a medialib entry. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_set_str_with_source (xmmsc_connection_t *c, int id, const char *source, const char *key, const char *value)
	Set a custom field in the medialib associated with a entry, the same as xmmsc_medialib_entry_property_set_str but with specifing your own source. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_remove (xmmsc_connection_t *c, int id, const char *key)
	Remove a custom field in the medialib associated with an entry. More...
xmmsc_result_t *	xmmsc_medialib_entry_property_remove_with_source (xmmsc_connection_t *c, int id, const char *source, const char *key)
	Remove a custom field in the medialib associated with an entry. More...

Detailed Description

This controls the medialib.

Function Documentation

xmmsc_result_t* xmmsc_broadcast_medialib_entry_added

(

xmmsc_connection_t *

c

)

Request the medialib_entry_added broadcast.

This will be called if a new entry is added to the medialib serverside.

xmmsc_result_t* xmmsc_broadcast_medialib_entry_changed

(

xmmsc_connection_t *

c

)

Request the medialib_entry_updated broadcast.

This will be called if a entry changes on the serverside. The argument will be an medialib id.

xmmsc_result_t* xmmsc_broadcast_medialib_entry_removed

(

xmmsc_connection_t *

c

)

Request the medialib_entry_removed broadcast.

This will be called if a entry is removed on the serverside. The argument will be an medialib id.

xmmsc_result_t* xmmsc_broadcast_medialib_entry_updated

(

xmmsc_connection_t *

c

)

Request the medialib_entry_updated broadcast.

This will be called if a entry changes on the serverside. The argument will be an medialib id.

FIXME: same as entry_changed() above. Calls to this function should be replaced and the function removed.

xmmsc_result_t* xmmsc_medialib_add_entry	(	xmmsc_connection_t *	conn,
		const char *	url
	)

Add a URL to the medialib.

If you want to add mutiple files you should call xmmsc_medialib_import_path

Parameters

conn	The xmmsc_connection_t
url	URL to add to the medialib.

xmmsc_result_t* xmmsc_medialib_add_entry_args	(	xmmsc_connection_t *	conn,
		const char *	url,
		int	numargs,
		const char **	args
	)

Add a URL with arguments to the medialib.

xmmsc_medialib_add_entry_args (conn, "file:///data/HVSC/C64Music/Hubbard_Rob/Commando.sid", 1, "subtune=2");

Parameters

conn	The xmmsc_connection_t
url	URL to add to the medialib.
numargs	The number of arguments
args	array of numargs strings used as arguments

xmmsc_result_t* xmmsc_medialib_add_entry_encoded	(	xmmsc_connection_t *	conn,
		const char *	url
	)

Add a URL to the medialib.

If you want to add mutiple files you should call xmmsc_medialib_import_path

same as xmmsc_medialib_add_entry but expects a encoded URL instead

Parameters

conn	The xmmsc_connection_t
url	URL to add to the medialib.

Referenced by xmmsc_medialib_add_entry_args(), and xmmsc_medialib_add_entry_full().

xmmsc_result_t* xmmsc_medialib_add_entry_full	(	xmmsc_connection_t *	conn,
		const char *	url,
		xmmsv_t *	args
	)

Add a URL with arguments to the medialib.

Parameters

conn	The xmmsc_connection_t
url	URL to add to the medialib.
numargs	The number of arguments
args	array of numargs strings used as arguments

Referenced by xmmsc_medialib_add_entry().

xmmsc_result_t* xmmsc_medialib_entry_property_remove	(	xmmsc_connection_t *	c,
		int	id,
		const char *	key
	)

Remove a custom field in the medialib associated with an entry.

Uses default source which is client/<clientname>

xmmsc_result_t* xmmsc_medialib_entry_property_remove_with_source	(	xmmsc_connection_t *	c,
		int	id,
		const char *	source,
		const char *	key
	)

Remove a custom field in the medialib associated with an entry.

Identical to xmmsc_medialib_entry_property_remove except with specifying your own source.

Referenced by xmmsc_medialib_entry_property_remove().

xmmsc_result_t* xmmsc_medialib_entry_property_set_int	(	xmmsc_connection_t *	c,
		int	id,
		const char *	key,
		int32_t	value
	)

Associate a int value with a medialib entry.

Uses default source which is client/<clientname>

xmmsc_result_t* xmmsc_medialib_entry_property_set_int_with_source	(	xmmsc_connection_t *	c,
		int	id,
		const char *	source,
		const char *	key,
		int32_t	value
	)

Set a custom int field in the medialib associated with a entry, the same as xmmsc_medialib_entry_property_set_int but with specifing your own source.

Referenced by xmmsc_medialib_entry_property_set_int().

xmmsc_result_t* xmmsc_medialib_entry_property_set_str	(	xmmsc_connection_t *	c,
		int	id,
		const char *	key,
		const char *	value
	)

Associate a value with a medialib entry.

Uses default source which is client/<clientname>

xmmsc_result_t* xmmsc_medialib_entry_property_set_str_with_source	(	xmmsc_connection_t *	c,
		int	id,
		const char *	source,
		const char *	key,
		const char *	value
	)

Set a custom field in the medialib associated with a entry, the same as xmmsc_medialib_entry_property_set_str but with specifing your own source.

Referenced by xmmsc_medialib_entry_property_set_str().

xmmsc_result_t* xmmsc_medialib_get_id	(	xmmsc_connection_t *	conn,
		const char *	url
	)

Search for a entry (URL) in the medialib db and return its ID number.

Parameters

conn	The xmmsc_connection_t
url	The URL to search for

xmmsc_result_t* xmmsc_medialib_get_id_encoded	(	xmmsc_connection_t *	conn,
		const char *	url
	)

Search for a entry (URL) in the medialib db and return its ID number.

Same as xmmsc_medialib_get_id but expects a encoded URL instead

Parameters

conn	The xmmsc_connection_t
url	The URL to search for

Referenced by xmmsc_medialib_get_id().

xmmsc_result_t* xmmsc_medialib_get_info	(	xmmsc_connection_t *	c,
		int	id
	)

Retrieve information about a entry from the medialib.

xmmsc_result_t* xmmsc_medialib_import_path	(	xmmsc_connection_t *	conn,
		const char *	path
	)

Import a all files recursivly from the directory passed as argument.

Parameters

conn	xmmsc_connection_t
path	A directory to recursive search for mediafiles, this must include the protocol, i.e file://

Referenced by xmmsc_medialib_path_import().

xmmsc_result_t* xmmsc_medialib_import_path_encoded	(	xmmsc_connection_t *	conn,
		const char *	path
	)

Import a all files recursivly from the directory passed as argument which must already be url encoded.

You probably want to use xmmsc_medialib_import_path unless you want to add a string that comes as a result from the daemon, such as from xmmsc_xform_media_browse

Parameters

conn	xmmsc_connection_t
path	A directory to recursive search for mediafiles, this must include the protocol, i.e file://

Referenced by xmmsc_medialib_import_path(), and xmmsc_medialib_path_import_encoded().

xmmsc_result_t* xmmsc_medialib_move_entry	(	xmmsc_connection_t *	conn,
		int	entry,
		const char *	url
	)

Change the url property of an entry in the media library.

Note that you need to handle the actual file move yourself.

Parameters

conn	The xmmsc_connection_t
entry	The entry id you want to move
url	The url to move it to

xmmsc_result_t* xmmsc_medialib_path_import	(	xmmsc_connection_t *	conn,
		const char *	path
	)

Import a all files recursivly from the directory passed as argument.

Parameters

conn	xmmsc_connection_t
path	A directory to recursive search for mediafiles, this must include the protocol, i.e file://

xmmsc_result_t* xmmsc_medialib_path_import_encoded	(	xmmsc_connection_t *	conn,
		const char *	path
	)

Import a all files recursivly from the directory passed as argument which must already be url encoded.

You probably want to use xmmsc_medialib_path_import unless you want to add a string that comes as a result from the daemon, such as from xmmsc_xform_media_browse

Parameters

conn	xmmsc_connection_t
path	A directory to recursive search for mediafiles, this must include the protocol, i.e file://

xmmsc_result_t* xmmsc_medialib_rehash	(	xmmsc_connection_t *	conn,
		int	id
	)

Rehash the medialib, this will check data in the medialib still is the same as the data in files.

Parameters

conn	xmmsc_connection_t
id	The id to rehash. Set it to 0 if you want to rehash the whole medialib.

xmmsc_result_t* xmmsc_medialib_remove_entry	(	xmmsc_connection_t *	conn,
		int	entry
	)

Remove a entry from the medialib.

Parameters

conn	The xmmsc_connection_t
entry	The entry id you want to remove