include/xmmsclient/xmmsclient.h File Reference

#include "xmmsc/xmmsc_compiler.h"
#include "xmmsc/xmmsc_stdint.h"
#include "xmmsc/xmmsc_ipc_msg.h"
#include "xmmsc/xmmsc_idnumbers.h"
#include "xmmsc/xmmsv.h"
#include "xmmsc/xmmsv_coll.h"

Go to the source code of this file.

Data Structures

struct  xmmsv_coll_token_St

Defines

#define XMMS_COLLECTION_TOKEN_CUSTOM   32
#define XMMS_CALLBACK_SET(conn, meth, callback, udata)   XMMS_CALLBACK_SET_FULL(conn,meth,callback,udata,NULL);
#define XMMS_CALLBACK_SET_FULL(conn, meth, callback, udata, free_func)
#define xmmsc_result_iserror(res)   xmmsv_is_error(xmmsc_result_get_value(res))
#define xmmsc_result_get_error(res)   xmmsv_get_error_old(xmmsc_result_get_value(res))
#define xmmsc_coll_parse   xmmsv_coll_parse
#define xmmsc_coll_parse_custom   xmmsv_coll_parse_custom
#define xmmsc_coll_default_parse_build   xmmsv_coll_default_parse_build
#define xmmsc_coll_default_parse_tokens   xmmsv_coll_default_parse_tokens

Typedefs

typedef struct xmmsc_connection_St xmmsc_connection_t
typedef struct xmmsc_result_St xmmsc_result_t
typedef void(* xmmsc_disconnect_func_t )(void *user_data)
typedef void(* xmmsc_user_data_free_func_t )(void *user_data)
typedef void(* xmmsc_io_need_out_callback_func_t )(int, void *)
typedef struct xmmsv_coll_token_St xmmsv_coll_token_t
typedef xmmsv_coll_token_t *(* xmmsv_coll_parse_tokens_f )(const char *str, const char **newpos)
typedef xmmsv_coll_t *(* xmmsv_coll_parse_build_f )(xmmsv_coll_token_t *tokens)
typedef int(* xmmsc_result_notifier_t )(xmmsv_t *val, void *user_data)
typedef xmmsv_coll_token_type_t xmmsc_coll_token_type_t
typedef xmmsv_coll_token_t xmmsc_coll_token_t
typedef xmmsv_coll_parse_tokens_f xmmsc_coll_parse_tokens_f
typedef xmmsv_coll_parse_build_f xmmsc_coll_parse_build_f

Enumerations

enum  xmmsc_result_type_t { XMMSC_RESULT_CLASS_DEFAULT, XMMSC_RESULT_CLASS_SIGNAL, XMMSC_RESULT_CLASS_BROADCAST }
enum  xmmsv_coll_token_type_t {
  XMMS_COLLECTION_TOKEN_INVALID, XMMS_COLLECTION_TOKEN_GROUP_OPEN, XMMS_COLLECTION_TOKEN_GROUP_CLOSE, XMMS_COLLECTION_TOKEN_REFERENCE,
  XMMS_COLLECTION_TOKEN_SYMBOL_ID, XMMS_COLLECTION_TOKEN_STRING, XMMS_COLLECTION_TOKEN_PATTERN, XMMS_COLLECTION_TOKEN_INTEGER,
  XMMS_COLLECTION_TOKEN_SEQUENCE, XMMS_COLLECTION_TOKEN_PROP_LONG, XMMS_COLLECTION_TOKEN_PROP_SHORT, XMMS_COLLECTION_TOKEN_OPSET_UNION,
  XMMS_COLLECTION_TOKEN_OPSET_INTERSECTION, XMMS_COLLECTION_TOKEN_OPSET_COMPLEMENT, XMMS_COLLECTION_TOKEN_OPFIL_HAS, XMMS_COLLECTION_TOKEN_OPFIL_EQUALS,
  XMMS_COLLECTION_TOKEN_OPFIL_MATCH, XMMS_COLLECTION_TOKEN_OPFIL_SMALLER, XMMS_COLLECTION_TOKEN_OPFIL_GREATER, XMMS_COLLECTION_TOKEN_OPFIL_SMALLEREQ,
  XMMS_COLLECTION_TOKEN_OPFIL_GREATEREQ
}

Functions

xmmsc_connection_txmmsc_init (const char *clientname)
 Initializes a xmmsc_connection_t.
int xmmsc_connect (xmmsc_connection_t *, const char *)
 Connects to the XMMS server.
xmmsc_connection_txmmsc_ref (xmmsc_connection_t *c)
 References the xmmsc_connection_t.
void xmmsc_unref (xmmsc_connection_t *c)
 Dereference the xmmsc_connection_t and free the memory when reference count reaches zero.
void xmmsc_lock_set (xmmsc_connection_t *conn, void *lock, void(*lockfunc)(void *), void(*unlockfunc)(void *))
 Set locking functions for a connection.
void xmmsc_disconnect_callback_set (xmmsc_connection_t *c, xmmsc_disconnect_func_t disconnect_func, void *userdata)
 Set the disconnect callback.
void xmmsc_disconnect_callback_set_full (xmmsc_connection_t *c, xmmsc_disconnect_func_t disconnect_func, void *userdata, xmmsc_user_data_free_func_t free_func)
void xmmsc_io_need_out_callback_set (xmmsc_connection_t *c, xmmsc_io_need_out_callback_func_t callback, void *userdata)
void xmmsc_io_need_out_callback_set_full (xmmsc_connection_t *c, xmmsc_io_need_out_callback_func_t callback, void *userdata, xmmsc_user_data_free_func_t free_func)
void xmmsc_io_disconnect (xmmsc_connection_t *c)
 Flag connection as disconnected.
int xmmsc_io_want_out (xmmsc_connection_t *c)
 Check for pending output.
int xmmsc_io_out_handle (xmmsc_connection_t *c)
 Write pending data.
int xmmsc_io_in_handle (xmmsc_connection_t *c)
 Read available data.
int xmmsc_io_fd_get (xmmsc_connection_t *c)
 Retrieve filedescriptor for connection.
char * xmmsc_get_last_error (xmmsc_connection_t *c)
 Returns a string that descibes the last error.
xmmsc_result_txmmsc_quit (xmmsc_connection_t *c)
 Tell the server to quit.
xmmsc_result_txmmsc_broadcast_quit (xmmsc_connection_t *c)
 Request the quit broadcast.
const char * xmmsc_userconfdir_get (char *buf, int len)
 Get the absolute path to the user config dir.
xmmsc_result_txmmsc_playlist_list (xmmsc_connection_t *c)
 List the existing playlists.
xmmsc_result_txmmsc_playlist_create (xmmsc_connection_t *c, const char *playlist)
 Create a new empty playlist.
xmmsc_result_txmmsc_playlist_shuffle (xmmsc_connection_t *c, const char *playlist)
 Shuffles the current playlist.
xmmsc_result_txmmsc_playlist_add_args (xmmsc_connection_t *c, const char *playlist, const char *, int, const char **) XMMS_DEPRECATED
 Add the url to the playlist with arguments.
xmmsc_result_txmmsc_playlist_add_full (xmmsc_connection_t *c, const char *playlist, const char *, xmmsv_t *)
 Add the url to the playlist with arguments.
xmmsc_result_txmmsc_playlist_add_url (xmmsc_connection_t *c, const char *playlist, const char *url)
 Add the url to the playlist.
xmmsc_result_txmmsc_playlist_add_id (xmmsc_connection_t *c, const char *playlist, int id)
 Add a medialib id to the playlist.
xmmsc_result_txmmsc_playlist_add_encoded (xmmsc_connection_t *c, const char *playlist, const char *url)
 Add the url to the playlist.
xmmsc_result_txmmsc_playlist_add_idlist (xmmsc_connection_t *c, const char *playlist, xmmsv_coll_t *coll)
 Adds media in idlist to a playlist.
xmmsc_result_txmmsc_playlist_add_collection (xmmsc_connection_t *c, const char *playlist, xmmsv_coll_t *coll, xmmsv_t *order)
 Queries the medialib for media and adds the matching ones to the current playlist.
xmmsc_result_txmmsc_playlist_remove_entry (xmmsc_connection_t *c, const char *playlist, int)
 Remove an entry from the playlist.
xmmsc_result_txmmsc_playlist_clear (xmmsc_connection_t *c, const char *playlist)
 Clears the current playlist.
xmmsc_result_txmmsc_playlist_remove (xmmsc_connection_t *c, const char *playlist)
 Remove the given playlist.
xmmsc_result_txmmsc_playlist_list_entries (xmmsc_connection_t *c, const char *playlist)
 List current playlist.
xmmsc_result_txmmsc_playlist_sort (xmmsc_connection_t *c, const char *playlist, xmmsv_t *properties)
 Sorts the playlist according to the list of properties (xmmsv_t containing a list of strings).
xmmsc_result_txmmsc_playlist_set_next (xmmsc_connection_t *c, int32_t)
xmmsc_result_txmmsc_playlist_set_next_rel (xmmsc_connection_t *c, int32_t)
xmmsc_result_txmmsc_playlist_move_entry (xmmsc_connection_t *c, const char *playlist, int, int)
 Move a playlist entry to a new position (absolute move).
xmmsc_result_txmmsc_playlist_current_pos (xmmsc_connection_t *c, const char *playlist)
 Retrive the current position in the playlist.
xmmsc_result_txmmsc_playlist_current_active (xmmsc_connection_t *c)
 Retrive the name of the active playlist.
xmmsc_result_txmmsc_playlist_insert_args (xmmsc_connection_t *c, const char *playlist, int pos, const char *url, int numargs, const char **args) XMMS_DEPRECATED
 Insert entry at given position in playlist with args.
xmmsc_result_txmmsc_playlist_insert_full (xmmsc_connection_t *c, const char *playlist, int pos, const char *url, xmmsv_t *args)
 Insert entry at given position in playlist with args.
xmmsc_result_txmmsc_playlist_insert_url (xmmsc_connection_t *c, const char *playlist, int pos, const char *url)
 Insert entry at given position in playlist.
xmmsc_result_txmmsc_playlist_insert_id (xmmsc_connection_t *c, const char *playlist, int pos, int32_t id)
xmmsc_result_txmmsc_playlist_insert_encoded (xmmsc_connection_t *c, const char *playlist, int pos, const char *url)
 Insert entry at given position in playlist.
xmmsc_result_txmmsc_playlist_insert_collection (xmmsc_connection_t *c, const char *playlist, int pos, xmmsv_coll_t *coll, xmmsv_t *order)
 Queries the medialib for media and inserts the matching ones to the current playlist at the given position.
xmmsc_result_txmmsc_playlist_load (xmmsc_connection_t *c, const char *playlist)
 Load a playlist as the current active playlist.
xmmsc_result_txmmsc_playlist_radd (xmmsc_connection_t *c, const char *playlist, const char *url)
 Adds a directory recursivly to the playlist.
xmmsc_result_txmmsc_playlist_radd_encoded (xmmsc_connection_t *c, const char *playlist, const char *url)
 Adds a directory recursivly to the playlist.
xmmsc_result_txmmsc_playlist_rinsert (xmmsc_connection_t *c, const char *playlist, int pos, const char *url)
 Insert a directory recursivly at a given position in the playlist.
xmmsc_result_txmmsc_playlist_rinsert_encoded (xmmsc_connection_t *c, const char *playlist, int pos, const char *url)
 Insert a directory recursivly at a given position in the playlist.
xmmsc_result_txmmsc_broadcast_playlist_changed (xmmsc_connection_t *c)
 Request the playlist changed broadcast from the server.
xmmsc_result_txmmsc_broadcast_playlist_current_pos (xmmsc_connection_t *c)
 Request the playlist current pos broadcast.
xmmsc_result_txmmsc_broadcast_playlist_loaded (xmmsc_connection_t *c)
 Request the playlist_loaded broadcast.
xmmsc_result_txmmsc_playback_stop (xmmsc_connection_t *c)
 Stops the current playback.
xmmsc_result_txmmsc_playback_tickle (xmmsc_connection_t *c)
 Stop decoding of current song.
xmmsc_result_txmmsc_playback_start (xmmsc_connection_t *c)
 Starts playback if server is idle.
xmmsc_result_txmmsc_playback_pause (xmmsc_connection_t *c)
 Pause the current playback, will tell the output to not read nor write.
xmmsc_result_txmmsc_playback_current_id (xmmsc_connection_t *c)
 Make server emit the current id.
xmmsc_result_txmmsc_playback_seek_ms (xmmsc_connection_t *c, int milliseconds, xmms_playback_seek_mode_t whence)
 Seek to a position given in milliseconds in the current playback.
xmmsc_result_txmmsc_playback_seek_ms_abs (xmmsc_connection_t *c, int milliseconds) XMMS_DEPRECATED
 Seek to a absolute time in the current playback.
xmmsc_result_txmmsc_playback_seek_ms_rel (xmmsc_connection_t *c, int milliseconds) XMMS_DEPRECATED
 Seek to a time relative to the current position in the current playback.
xmmsc_result_txmmsc_playback_seek_samples (xmmsc_connection_t *c, int samples, xmms_playback_seek_mode_t whence)
 Seek to a position given in samples in the current playback.
xmmsc_result_txmmsc_playback_seek_samples_abs (xmmsc_connection_t *c, int samples) XMMS_DEPRECATED
 Seek to a absoulte number of samples in the current playback.
xmmsc_result_txmmsc_playback_seek_samples_rel (xmmsc_connection_t *c, int samples) XMMS_DEPRECATED
 Seek to a number of samples relative to the current position in the current playback.
xmmsc_result_txmmsc_playback_playtime (xmmsc_connection_t *c)
 Make server emit the current playtime.
xmmsc_result_txmmsc_playback_status (xmmsc_connection_t *c)
 Make server emit the playback status.
xmmsc_result_txmmsc_playback_volume_set (xmmsc_connection_t *c, const char *channel, int volume)
xmmsc_result_txmmsc_playback_volume_get (xmmsc_connection_t *c)
xmmsc_result_txmmsc_broadcast_playback_volume_changed (xmmsc_connection_t *c)
xmmsc_result_txmmsc_broadcast_playback_status (xmmsc_connection_t *c)
 Requests the playback status broadcast.
xmmsc_result_txmmsc_broadcast_playback_current_id (xmmsc_connection_t *c)
 Request the current id broadcast.
xmmsc_result_txmmsc_signal_playback_playtime (xmmsc_connection_t *c)
 Request the playback_playtime signal.
xmmsc_result_txmmsc_configval_set (xmmsc_connection_t *c, const char *key, const char *val) XMMS_DEPRECATED
 Sets a configvalue in the server.
xmmsc_result_txmmsc_configval_list (xmmsc_connection_t *c) XMMS_DEPRECATED
 Lists all configuration values.
xmmsc_result_txmmsc_configval_get (xmmsc_connection_t *c, const char *key) XMMS_DEPRECATED
 Retrives a list of configvalues in server.
xmmsc_result_txmmsc_configval_register (xmmsc_connection_t *c, const char *valuename, const char *defaultvalue) XMMS_DEPRECATED
 Registers a configvalue in the server.
xmmsc_result_txmmsc_config_set_value (xmmsc_connection_t *c, const char *key, const char *val)
 Sets a configvalue in the server.
xmmsc_result_txmmsc_config_list_values (xmmsc_connection_t *c)
 Lists all configuration values.
xmmsc_result_txmmsc_config_get_value (xmmsc_connection_t *c, const char *key)
 Retrieves a configvalue from the server.
xmmsc_result_txmmsc_config_register_value (xmmsc_connection_t *c, const char *valuename, const char *defaultvalue)
 Registers a configvalue in the server.
xmmsc_result_txmmsc_broadcast_configval_changed (xmmsc_connection_t *c) XMMS_DEPRECATED
 Requests the configval_changed broadcast.
xmmsc_result_txmmsc_broadcast_config_value_changed (xmmsc_connection_t *c)
 Requests the config_value_changed broadcast.
xmmsc_result_txmmsc_plugin_list (xmmsc_connection_t *c, xmms_plugin_type_t type) XMMS_DEPRECATED
 Get a list of loaded plugins from the server.
xmmsc_result_txmmsc_main_list_plugins (xmmsc_connection_t *c, xmms_plugin_type_t type)
 Get a list of loaded plugins from the server.
xmmsc_result_txmmsc_main_stats (xmmsc_connection_t *c)
 Get a list of statistics from the server.
xmmsc_result_txmmsc_broadcast_mediainfo_reader_status (xmmsc_connection_t *c)
 Request status for the mediainfo reader.
xmmsc_result_txmmsc_signal_mediainfo_reader_unindexed (xmmsc_connection_t *c)
 Request number of unindexed entries in medialib.
xmmsc_result_txmmsc_visualization_version (xmmsc_connection_t *c)
 Querys the visualization version.
xmmsc_result_txmmsc_visualization_init (xmmsc_connection_t *c)
 Initializes a new visualization dataset.
int xmmsc_visualization_init_handle (xmmsc_result_t *res)
xmmsc_result_txmmsc_visualization_start (xmmsc_connection_t *c, int vv)
 Initializes a new visualization connection.
void xmmsc_visualization_start_handle (xmmsc_connection_t *c, xmmsc_result_t *res)
bool xmmsc_visualization_started (xmmsc_connection_t *c, int vv)
bool xmmsc_visualization_errored (xmmsc_connection_t *c, int vv)
xmmsc_result_txmmsc_visualization_property_set (xmmsc_connection_t *c, int v, const char *key, const char *value)
 Deliver one property.
xmmsc_result_txmmsc_visualization_properties_set (xmmsc_connection_t *c, int v, xmmsv_t *props)
 Deliver some properties.
int xmmsc_visualization_chunk_get (xmmsc_connection_t *c, int vv, short *buffer, int drawtime, unsigned int blocking)
 Fetches the next available data chunk.
void xmmsc_visualization_shutdown (xmmsc_connection_t *c, int v)
 Says goodbye and cleans up.
int xmmsc_entry_format (char *target, int len, const char *fmt, xmmsv_t *val) XMMS_DEPRECATED
 This function will make a pretty string about the information in the mediainfo hash supplied to it.
xmmsc_result_txmmsc_medialib_add_entry (xmmsc_connection_t *conn, const char *url)
 Add a URL to the medialib.
xmmsc_result_txmmsc_medialib_add_entry_args (xmmsc_connection_t *conn, const char *url, int numargs, const char **args) XMMS_DEPRECATED
 Add a URL with arguments to the medialib.
xmmsc_result_txmmsc_medialib_add_entry_full (xmmsc_connection_t *conn, const char *url, xmmsv_t *args)
 Add a URL with arguments to the medialib.
xmmsc_result_txmmsc_medialib_add_entry_encoded (xmmsc_connection_t *conn, const char *url)
 Add a URL to the medialib.
xmmsc_result_txmmsc_medialib_get_info (xmmsc_connection_t *, int)
 Retrieve information about a entry from the medialib.
xmmsc_result_txmmsc_medialib_path_import (xmmsc_connection_t *conn, const char *path) XMMS_DEPRECATED
 Import a all files recursivly from the directory passed as argument.
xmmsc_result_txmmsc_medialib_path_import_encoded (xmmsc_connection_t *conn, const char *path) XMMS_DEPRECATED
 Import a all files recursivly from the directory passed as argument which must already be url encoded.
xmmsc_result_txmmsc_medialib_import_path (xmmsc_connection_t *conn, const char *path)
 Import a all files recursivly from the directory passed as argument.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_medialib_get_id (xmmsc_connection_t *conn, const char *url)
 Search for a entry (URL) in the medialib db and return its ID number.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_medialib_remove_entry (xmmsc_connection_t *conn, int entry)
 Remove a entry from the medialib.
xmmsc_result_txmmsc_medialib_move_entry (xmmsc_connection_t *conn, int entry, const char *url)
 Change the url property of an entry in the media library.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_medialib_entry_property_set_str (xmmsc_connection_t *c, int id, const char *key, const char *value)
 Associate a value with a medialib entry.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_medialib_entry_property_remove (xmmsc_connection_t *c, int id, const char *key)
 Remove a custom field in the medialib associated with an entry.
xmmsc_result_txmmsc_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.
xmmsc_result_txmmsc_xform_media_browse (xmmsc_connection_t *c, const char *url)
 Browse available media in a path.
xmmsc_result_txmmsc_xform_media_browse_encoded (xmmsc_connection_t *c, const char *url)
 Browse available media in a (already encoded) path.
xmmsc_result_txmmsc_bindata_add (xmmsc_connection_t *c, const unsigned char *data, unsigned int len)
 Add binary data to the servers bindata directory.
xmmsc_result_txmmsc_bindata_retrieve (xmmsc_connection_t *c, const char *hash)
 Retrieve a file from the servers bindata directory, based on the hash.
xmmsc_result_txmmsc_bindata_remove (xmmsc_connection_t *c, const char *hash)
 Remove a file with associated with the hash from the server.
xmmsc_result_txmmsc_bindata_list (xmmsc_connection_t *c)
 List all bindata hashes stored on the server.
xmmsc_result_txmmsc_broadcast_medialib_entry_changed (xmmsc_connection_t *c)
 Request the medialib_entry_changed broadcast.
xmmsc_result_txmmsc_broadcast_medialib_entry_added (xmmsc_connection_t *c)
 Request the medialib_entry_added broadcast.
xmmsc_result_txmmsc_coll_get (xmmsc_connection_t *conn, const char *collname, xmmsv_coll_namespace_t ns)
 Get the collection structure of a collection saved on the server.
xmmsc_result_txmmsc_coll_list (xmmsc_connection_t *conn, xmmsv_coll_namespace_t ns)
 List all collections saved on the server in the given namespace.
xmmsc_result_txmmsc_coll_save (xmmsc_connection_t *conn, xmmsv_coll_t *coll, const char *name, xmmsv_coll_namespace_t ns)
 Save a collection structure on the server under the given name, in the given namespace.
xmmsc_result_txmmsc_coll_remove (xmmsc_connection_t *conn, const char *name, xmmsv_coll_namespace_t ns)
 Remove a collection from the server.
xmmsc_result_txmmsc_coll_find (xmmsc_connection_t *conn, int mediaid, xmmsv_coll_namespace_t ns)
 Find all collections in the given namespace which match the given media.
xmmsc_result_txmmsc_coll_rename (xmmsc_connection_t *conn, const char *from_name, const char *to_name, xmmsv_coll_namespace_t ns)
 Rename a saved collection.
xmmsc_result_txmmsc_coll_idlist_from_playlist_file (xmmsc_connection_t *conn, const char *path)
 Create a new collections structure with type idlist from a playlist file.
xmmsc_result_txmmsc_coll_sync (xmmsc_connection_t *conn)
 Synchronize collection data to the database.
xmmsc_result_txmmsc_coll_query_ids (xmmsc_connection_t *conn, xmmsv_coll_t *coll, xmmsv_t *order, int limit_start, int limit_len)
 List the ids of all media matched by the given collection.
xmmsc_result_txmmsc_coll_query_infos (xmmsc_connection_t *conn, xmmsv_coll_t *coll, xmmsv_t *order, int limit_start, int limit_len, xmmsv_t *fetch, xmmsv_t *group)
 List the properties of all media matched by the given collection.
int xmmsv_coll_parse (const char *pattern, xmmsv_coll_t **coll)
 Try to parse the given pattern to produce a collection structure.
int xmmsv_coll_parse_custom (const char *pattern, xmmsv_coll_parse_tokens_f parse_f, xmmsv_coll_parse_build_f build_f, xmmsv_coll_t **coll)
 Try to parse the given pattern to produce a collection structure, using custom token-parsing and collection-building functions.
xmmsv_coll_txmmsv_coll_default_parse_build (xmmsv_coll_token_t *tokens)
 Default collection structure builder.
xmmsv_coll_token_txmmsv_coll_default_parse_tokens (const char *str, const char **newpos)
 The default token parser.
xmmsc_result_txmmsc_broadcast_collection_changed (xmmsc_connection_t *c)
 Request the collection changed broadcast from the server.
xmmsc_result_type_t xmmsc_result_get_class (xmmsc_result_t *res)
 Get the class of the result (default, signal, broadcast).
void xmmsc_result_disconnect (xmmsc_result_t *res)
 Disconnect a signal or a broadcast.
xmmsc_result_txmmsc_result_ref (xmmsc_result_t *res)
 References the xmmsc_result_t.
void xmmsc_result_unref (xmmsc_result_t *res)
 Decreases the references for the xmmsc_result_t When the number of references reaches 0 it will be freed.
void xmmsc_result_notifier_set (xmmsc_result_t *res, xmmsc_result_notifier_t func, void *user_data)
 Set up a callback for the result retrival.
void xmmsc_result_notifier_set_full (xmmsc_result_t *res, xmmsc_result_notifier_t func, void *user_data, xmmsc_user_data_free_func_t free_func)
 Set up a callback for the result retrieval.
void xmmsc_result_wait (xmmsc_result_t *res)
 Block for the reply.
xmmsv_t * xmmsc_result_get_value (xmmsc_result_t *res)
 Get the value from a result.

Define Documentation

#define XMMS_CALLBACK_SET ( conn,
meth,
callback,
udata   )     XMMS_CALLBACK_SET_FULL(conn,meth,callback,udata,NULL);

Definition at line 326 of file xmmsclient.h.

#define XMMS_CALLBACK_SET_FULL ( conn,
meth,
callback,
udata,
free_func   ) 
Value:
{\
    xmmsc_result_t *res = meth (conn); \
    xmmsc_result_notifier_set_full (res, callback, udata, free_func);\
    xmmsc_result_unref (res);\
}

Definition at line 329 of file xmmsclient.h.

#define XMMS_COLLECTION_TOKEN_CUSTOM   32

Definition at line 298 of file xmmsclient.h.

#define xmmsc_coll_default_parse_build   xmmsv_coll_default_parse_build

Definition at line 366 of file xmmsclient.h.

#define xmmsc_coll_default_parse_tokens   xmmsv_coll_default_parse_tokens

Definition at line 367 of file xmmsclient.h.

#define xmmsc_coll_parse   xmmsv_coll_parse

Definition at line 364 of file xmmsclient.h.

#define xmmsc_coll_parse_custom   xmmsv_coll_parse_custom

Definition at line 365 of file xmmsclient.h.

#define xmmsc_result_get_error ( res   )     xmmsv_get_error_old(xmmsc_result_get_value(res))

Definition at line 355 of file xmmsclient.h.

#define xmmsc_result_iserror ( res   )     xmmsv_is_error(xmmsc_result_get_value(res))

Typedef Documentation

Definition at line 362 of file xmmsclient.h.

Definition at line 361 of file xmmsclient.h.

Definition at line 360 of file xmmsclient.h.

Definition at line 359 of file xmmsclient.h.

typedef struct xmmsc_connection_St xmmsc_connection_t

Definition at line 31 of file xmmsclient.h.

typedef void(* xmmsc_disconnect_func_t)(void *user_data)

Definition at line 40 of file xmmsclient.h.

typedef void(* xmmsc_io_need_out_callback_func_t)(int, void *)

Definition at line 42 of file xmmsclient.h.

typedef int(* xmmsc_result_notifier_t)(xmmsv_t *val, void *user_data)

Definition at line 339 of file xmmsclient.h.

typedef struct xmmsc_result_St xmmsc_result_t

Definition at line 32 of file xmmsclient.h.

typedef void(* xmmsc_user_data_free_func_t)(void *user_data)

Definition at line 41 of file xmmsclient.h.

Definition at line 309 of file xmmsclient.h.

typedef xmmsv_coll_token_t*(* xmmsv_coll_parse_tokens_f)(const char *str, const char **newpos)

Definition at line 308 of file xmmsclient.h.

Definition at line 300 of file xmmsclient.h.


Enumeration Type Documentation

Enumerator:
XMMSC_RESULT_CLASS_DEFAULT 
XMMSC_RESULT_CLASS_SIGNAL 
XMMSC_RESULT_CLASS_BROADCAST 

Definition at line 34 of file xmmsclient.h.

Enumerator:
XMMS_COLLECTION_TOKEN_INVALID 
XMMS_COLLECTION_TOKEN_GROUP_OPEN 
XMMS_COLLECTION_TOKEN_GROUP_CLOSE 
XMMS_COLLECTION_TOKEN_REFERENCE 
XMMS_COLLECTION_TOKEN_SYMBOL_ID 
XMMS_COLLECTION_TOKEN_STRING 
XMMS_COLLECTION_TOKEN_PATTERN 
XMMS_COLLECTION_TOKEN_INTEGER 
XMMS_COLLECTION_TOKEN_SEQUENCE 
XMMS_COLLECTION_TOKEN_PROP_LONG 
XMMS_COLLECTION_TOKEN_PROP_SHORT 
XMMS_COLLECTION_TOKEN_OPSET_UNION 
XMMS_COLLECTION_TOKEN_OPSET_INTERSECTION 
XMMS_COLLECTION_TOKEN_OPSET_COMPLEMENT 
XMMS_COLLECTION_TOKEN_OPFIL_HAS 
XMMS_COLLECTION_TOKEN_OPFIL_EQUALS 
XMMS_COLLECTION_TOKEN_OPFIL_MATCH 
XMMS_COLLECTION_TOKEN_OPFIL_SMALLER 
XMMS_COLLECTION_TOKEN_OPFIL_GREATER 
XMMS_COLLECTION_TOKEN_OPFIL_SMALLEREQ 
XMMS_COLLECTION_TOKEN_OPFIL_GREATEREQ 

Definition at line 274 of file xmmsclient.h.


Function Documentation

xmmsc_result_t* xmmsc_bindata_add ( xmmsc_connection_t c,
const unsigned char *  data,
unsigned int  len 
)

Add binary data to the servers bindata directory.

Definition at line 32 of file bindata.c.

xmmsc_result_t* xmmsc_bindata_list ( xmmsc_connection_t c  ) 

List all bindata hashes stored on the server.

Definition at line 76 of file bindata.c.

xmmsc_result_t* xmmsc_bindata_remove ( xmmsc_connection_t c,
const char *  hash 
)

Remove a file with associated with the hash from the server.

Definition at line 64 of file bindata.c.

xmmsc_result_t* xmmsc_bindata_retrieve ( xmmsc_connection_t c,
const char *  hash 
)

Retrieve a file from the servers bindata directory, based on the hash.

Definition at line 52 of file bindata.c.

void xmmsc_io_need_out_callback_set ( xmmsc_connection_t c,
xmmsc_io_need_out_callback_func_t  callback,
void *  userdata 
)
void xmmsc_io_need_out_callback_set_full ( xmmsc_connection_t c,
xmmsc_io_need_out_callback_func_t  callback,
void *  userdata,
xmmsc_user_data_free_func_t  free_func 
)
xmmsc_result_t* xmmsc_playlist_insert_id ( xmmsc_connection_t c,
const char *  playlist,
int  pos,
int32_t  id 
)
xmmsc_result_t* xmmsc_playlist_set_next ( xmmsc_connection_t c,
int32_t   
)
xmmsc_result_t* xmmsc_playlist_set_next_rel ( xmmsc_connection_t c,
int32_t   
)
xmmsc_result_t* xmmsc_xform_media_browse ( xmmsc_connection_t c,
const char *  url 
)

Browse available media in a path.

Retrieves a list of paths available (directly) under the specified path.

Definition at line 34 of file xform.c.

xmmsc_result_t* xmmsc_xform_media_browse_encoded ( xmmsc_connection_t c,
const char *  url 
)

Browse available media in a (already encoded) path.

Retrieves a list of paths available (directly) under the specified path.

Definition at line 61 of file xform.c.

Referenced by xmmsc_xform_media_browse().


Generated on Tue Feb 23 18:17:57 2010 for XmmsClient by  doxygen 1.6.1