libmpdclient  2.17
Functions
sticker.h File Reference

MPD client library. More...

Go to the source code of this file.

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_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)
 
mpd_malloc struct mpd_pairmpd_recv_sticker (struct mpd_connection *connection)
 
void mpd_return_sticker (struct mpd_connection *connection, struct mpd_pair *pair)
 

Detailed Description

MPD client library.

Manipulate stickers.

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

Definition in file sticker.h.

Function Documentation

◆ mpd_send_sticker_set()

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

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

◆ mpd_run_sticker_set()

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

◆ mpd_send_sticker_delete()

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

◆ mpd_run_sticker_delete()

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

◆ mpd_send_sticker_get()

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

◆ mpd_send_sticker_list()

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

◆ mpd_send_sticker_find()

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.

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

◆ mpd_parse_sticker()

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

◆ mpd_recv_sticker()

mpd_malloc 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

◆ mpd_return_sticker()

void mpd_return_sticker ( struct mpd_connection connection,
struct mpd_pair pair 
)

Free the pair returned by mpd_recv_sticker().

Since
libmpdclient 2.1