libmpdclient  2.23
Enumerations | Functions
sticker.h File Reference

MPD client library. More...

#include "compiler.h"
#include <stdbool.h>
#include <stddef.h>
Include dependency graph for sticker.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  mpd_sticker_operator {
  MPD_STICKER_OP_UNKOWN = -1, MPD_STICKER_OP_EQ, MPD_STICKER_OP_GT, MPD_STICKER_OP_LT,
  MPD_STICKER_OP_EQ_INT, MPD_STICKER_OP_GT_INT, MPD_STICKER_OP_LT_INT, MPD_STICKER_OP_CONTAINS,
  MPD_STICKER_OP_STARTS_WITH
}
 
enum  mpd_sticker_sort { MPD_STICKER_SORT_UNKOWN = -1, MPD_STICKER_SORT_URI, MPD_STICKER_SORT_VALUE, MPD_STICKER_SORT_VALUE_INT }
 

Functions

bool mpd_send_sticker_set (struct mpd_connection *connection, const char *type, const char *uri, const char *name, const char *value)
 
bool mpd_run_sticker_set (struct mpd_connection *connection, const char *type, const char *uri, const char *name, const char *value)
 
bool mpd_send_sticker_inc (struct mpd_connection *connection, const char *type, const char *uri, const char *name, unsigned value)
 
bool mpd_run_sticker_inc (struct mpd_connection *connection, const char *type, const char *uri, const char *name, unsigned value)
 
bool mpd_send_sticker_dec (struct mpd_connection *connection, const char *type, const char *uri, const char *name, unsigned value)
 
bool mpd_run_sticker_dec (struct mpd_connection *connection, const char *type, const char *uri, const char *name, unsigned value)
 
bool mpd_send_sticker_delete (struct mpd_connection *connection, const char *type, const char *uri, const char *name)
 
bool mpd_run_sticker_delete (struct mpd_connection *connection, const char *type, const char *uri, const char *name)
 
bool mpd_send_sticker_get (struct mpd_connection *connection, const char *type, const char *uri, const char *name)
 
bool mpd_send_sticker_list (struct mpd_connection *connection, const char *type, const char *uri)
 
bool mpd_send_sticker_find (struct mpd_connection *connection, const char *type, const char *base_uri, const char *name)
 
const char * mpd_parse_sticker (const char *input, size_t *name_length_r)
 
struct mpd_pairmpd_recv_sticker (struct mpd_connection *connection)
 
void mpd_return_sticker (struct mpd_connection *connection, struct mpd_pair *pair)
 
bool mpd_send_stickernames (struct mpd_connection *connection)
 
bool mpd_send_stickertypes (struct mpd_connection *connection)
 
bool mpd_send_stickernamestypes (struct mpd_connection *connection, const char *type)
 
bool mpd_sticker_search_begin (struct mpd_connection *connection, const char *type, const char *base_uri, const char *name)
 
bool mpd_sticker_search_add_value_constraint (struct mpd_connection *connection, enum mpd_sticker_operator oper, const char *value)
 
bool mpd_sticker_search_add_sort (struct mpd_connection *connection, enum mpd_sticker_sort sort, bool descending)
 
bool mpd_sticker_search_add_window (struct mpd_connection *connection, unsigned start, unsigned end)
 
bool mpd_sticker_search_commit (struct mpd_connection *connection)
 
void mpd_sticker_search_cancel (struct mpd_connection *connection)
 

Detailed Description

MPD client library.

Manipulate stickers.

Do not include this header directly. Use mpd/client.h instead.

Definition in file sticker.h.

Enumeration Type Documentation

Comparison operators for sticker search api

Enumerator
MPD_STICKER_OP_UNKOWN 
MPD_STICKER_OP_EQ 
MPD_STICKER_OP_GT 
MPD_STICKER_OP_LT 
MPD_STICKER_OP_EQ_INT 
MPD_STICKER_OP_GT_INT 
MPD_STICKER_OP_LT_INT 
MPD_STICKER_OP_CONTAINS 
MPD_STICKER_OP_STARTS_WITH 

Definition at line 25 of file sticker.h.

Sort by settings for sticker search api

Enumerator
MPD_STICKER_SORT_UNKOWN 
MPD_STICKER_SORT_URI 
MPD_STICKER_SORT_VALUE 
MPD_STICKER_SORT_VALUE_INT 

Definition at line 40 of file sticker.h.

Function Documentation

bool mpd_send_sticker_set ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
const char *  value 
)

Stickers are pieces of information attached to existing MPD objects (e.g. song files, directories, albums; but currently, they are only implemented for song). Clients can create arbitrary name/value pairs. MPD itself does not assume any special meaning in them.

The goal is to allow clients to share additional (possibly dynamic) information about songs, which is neither stored on the client (not available to other clients), nor stored in the song files (MPD has no write access).

Client developers should create a standard for common sticker names, to ensure interoperability.

Objects which may have stickers are addressed by their object type ("song" for song objects) and their URI (the path within the database for songs). Adds or replaces a sticker value.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe value of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_run_sticker_set ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
const char *  value 
)

Shortcut for mpd_send_sticker_set() and mpd_response_finish().

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe value of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_send_sticker_inc ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
unsigned  value 
)

Adds or increments a sticker value.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe unsigned value to set or increment
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_run_sticker_inc ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
unsigned  value 
)

Shortcut for mpd_send_sticker_inc() and mpd_response_finish().

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe unsigned value to set or increment
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_send_sticker_dec ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
unsigned  value 
)

Adds or decrements a sticker value.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe unsigned value to set or increment
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_run_sticker_dec ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name,
unsigned  value 
)

Shortcut for mpd_send_sticker_dec() and mpd_response_finish().

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
valuethe unsigned value to set or increment
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_send_sticker_delete ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name 
)

Deletes a sticker value.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_run_sticker_delete ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name 
)

Shortcut for mpd_send_sticker_delete() and mpd_response_finish().

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_send_sticker_get ( struct mpd_connection connection,
const char *  type,
const char *  uri,
const char *  name 
)

Queries a sticker value. Call mpd_recv_sticker() to receive the response.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
namethe name of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_send_sticker_list ( struct mpd_connection connection,
const char *  type,
const char *  uri 
)

Obtains a list of all stickers of the specified object. Call mpd_recv_sticker() to receive each response item.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
urithe URI of the object
Returns
true on success, false on error
Since
libmpdclient 2.1
bool mpd_send_sticker_find ( struct mpd_connection connection,
const char *  type,
const char *  base_uri,
const char *  name 
)

Searches for stickers with the specified name. Call mpd_recv_sticker() to receive each response item.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
base_urithe base URI to start the search, e.g. a directory; NULL to search for all objects of the specified type
namethe name of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.1
const char* mpd_parse_sticker ( const char *  input,
size_t *  name_length_r 
)

Parse a sticker input line in the form "name=value".

Parameters
inputthe input value, the value from a received pair named "sticker"
name_length_rthe length of the name (starting at the beginning of the input string) is returned here
Returns
a pointer to the sticker value, or NULL on error
Since
libmpdclient 2.1
struct mpd_pair* mpd_recv_sticker ( struct mpd_connection connection)

Receives the next sticker. You have to free the return value with mpd_return_sticker().

Parameters
connectionthe connection to MPD
Returns
a mpd_pair object on success, NULL on end of response or error
Since
libmpdclient 2.1
void mpd_return_sticker ( struct mpd_connection connection,
struct mpd_pair pair 
)

Free the pair returned by mpd_recv_sticker().

Since
libmpdclient 2.1
bool mpd_send_stickernames ( struct mpd_connection connection)

Obtains an uniq and sorted list of all sticker names. Call mpd_recv_pair() to receive each response item.

Parameters
connectionthe connection to MPD
Returns
true on success, false on error
Since
libmpdclient 2.21, MPD 0.24
bool mpd_send_stickertypes ( struct mpd_connection connection)

Obtains an uniq list of all sticker types. Call mpd_recv_pair() to receive each response item.

Parameters
connectionthe connection to MPD
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_send_stickernamestypes ( struct mpd_connection connection,
const char *  type 
)

Obtains an uniq and sorted list of all sticker names and their types. Call mpd_recv_pair() to receive each response item.

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song" or NULL for all types
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_sticker_search_begin ( struct mpd_connection connection,
const char *  type,
const char *  base_uri,
const char *  name 
)

Search for stickers in the database. Constraints may be specified. Send the search command with mpd_sticker_search_commit(), and read the response items with mpd_recv_sticker().

Parameters
connectionthe connection to MPD
typethe object type, e.g. "song"
base_urithe base URI to start the search, e.g. a directory; NULL to search for all objects of the specified type
namethe name of the sticker
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_sticker_search_add_value_constraint ( struct mpd_connection connection,
enum mpd_sticker_operator  oper,
const char *  value 
)

Adds the value constraint to the search

Parameters
connectiona mpd_connection
opercompare operator
valuevalue to compare against
Returns
true on success, else false
Since
libmpdclient 2.23, MPD 0.24
bool mpd_sticker_search_add_sort ( struct mpd_connection connection,
enum mpd_sticker_sort  sort,
bool  descending 
)

Sort the results by the specified named attribute.

Parameters
connectiona mpd_connection
sortsort by field
descendingsort in reverse order?
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_sticker_search_add_window ( struct mpd_connection connection,
unsigned  start,
unsigned  end 
)

Request only a portion of the result set.

Parameters
connectiona mpd_connection
startthe start offset (including)
endthe end offset (not including) value "UINT_MAX" makes the end of the range open
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
bool mpd_sticker_search_commit ( struct mpd_connection connection)

Starts the real search.

Parameters
connectionthe connection to MPD
Returns
true on success, false on error
Since
libmpdclient 2.23, MPD 0.24
void mpd_sticker_search_cancel ( struct mpd_connection connection)

Cancels the search request before you have called mpd_sticker_search_commit(). Call this to clear the current search request.

Parameters
connectionthe connection to MPD
Since
libmpdclient 2.23, MPD 0.24