sticker.h File Reference

myMPD sticker API More...

#include "src/lib/mympd_state.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.

Functions
sds	mympd_api_sticker_get (struct t_stickerdb_state *stickerdb, sds buffer, unsigned request_id, sds uri, enum mympd_sticker_type type, sds name)
sds	mympd_api_sticker_find (struct t_stickerdb_state *stickerdb, sds buffer, unsigned request_id, sds uri, enum mympd_sticker_type type, sds name, enum mpd_sticker_operator op, sds value, enum mpd_sticker_sort sort, bool sort_desc, unsigned offset, unsigned limit)
sds	mympd_api_sticker_list (struct t_stickerdb_state *stickerdb, sds buffer, unsigned request_id, sds uri, enum mympd_sticker_type type)
bool	mympd_api_sticker_set_feedback (struct t_stickerdb_state *stickerdb, struct t_list *trigger_list, const char *partition_name, enum mympd_sticker_type sticker_type, sds uri, enum mympd_feedback_type feedback_type, int value, sds *error)
sds	mympd_api_sticker_get_print (sds buffer, struct t_stickerdb_state *stickerdb, enum mympd_sticker_type type, const char *uri, const struct t_stickers *stickers)
sds	mympd_api_sticker_get_print_batch (sds buffer, struct t_stickerdb_state *stickerdb, enum mympd_sticker_type type, const char *uri, const struct t_stickers *stickers)
sds	mympd_api_sticker_print (sds buffer, struct t_sticker *sticker, const struct t_stickers *stickers)
sds	mympd_api_sticker_print_types (struct t_stickerdb_state *stickerdb, sds buffer)
sds	mympd_api_sticker_names (struct t_stickerdb_state *stickerdb, sds buffer, unsigned request_id, sds searchstr, enum mympd_sticker_type type)
sds	mympd_api_get_sticker_uri (struct t_mympd_state *mympd_state, sds uri, enum mympd_sticker_type *type)
enum mympd_sticker_type	mympd_api_get_mpd_sticker_type (enum mympd_sticker_type type)

Detailed Description

myMPD sticker API

Function Documentation

mympd_api_get_mpd_sticker_type()

enum mympd_sticker_type mympd_api_get_mpd_sticker_type

(

enum mympd_sticker_type

type

)

Translates myMPD specific sticker type to MPD sticker type

Parameters

type	myMPD sticker type

Returns

MPD sticker type

mympd_api_get_sticker_uri()

sds mympd_api_get_sticker_uri	(	struct t_mympd_state *	mympd_state,
		sds	uri,
		enum mympd_sticker_type *	type
	)

Translates the uri and type for myMPD specific sticker type

Parameters

mympd_state	Pointer to mympd_state
uri	Sticker URI
type	Pointer to mympd_sticker_type

Returns

Pointer to uri

mympd_api_sticker_find()

sds mympd_api_sticker_find	(	struct t_stickerdb_state *	stickerdb,
		sds	buffer,
		unsigned	request_id,
		sds	uri,
		enum mympd_sticker_type	type,
		sds	name,
		enum mpd_sticker_operator	op,
		sds	value,
		enum mpd_sticker_sort	sort,
		bool	sort_desc,
		unsigned	offset,
		unsigned	limit
	)

Gets a sorted list of stickers by name and value

Parameters

stickerdb	pointer to the stickerdb state
buffer	already allocated sds string to append the list
request_id	jsonrpc request id
uri	baseuri for search
type	MPD sticker type
name	sticker name
op	mpd sticker compare operator
value	sticker value or NULL to get all stickers with this name
sort	sticker sort type
sort_desc	sort descending?
offset	window start (including)
limit	window end (excluding), use UINT_MAX for open end

Returns

pointer to buffer

mympd_api_sticker_get()

sds mympd_api_sticker_get	(	struct t_stickerdb_state *	stickerdb,
		sds	buffer,
		unsigned	request_id,
		sds	uri,
		enum mympd_sticker_type	type,
		sds	name
	)

Gets a sticker value

Parameters

stickerdb	pointer to stickerdb
buffer	already allocated sds string to append the result
request_id	jsonrpc request id
uri	Sticker uri
type	MPD sticker type
name	Sticker name

Returns

Pointer to buffer

mympd_api_sticker_get_print()

sds mympd_api_sticker_get_print	(	sds	buffer,
		struct t_stickerdb_state *	stickerdb,
		enum mympd_sticker_type	type,
		const char *	uri,
		const struct t_stickers *	stickers
	)

Gets the stickers from stickerdb and returns a json list Shortcut for stickerdb_get_all and print_sticker

Parameters

buffer	already allocated sds string to append the list
stickerdb	pointer to stickerdb
type	MPD sticker type
uri	song uri
stickers	list of stickers to print

Returns

pointer to the modified buffer

mympd_api_sticker_get_print_batch()

sds mympd_api_sticker_get_print_batch	(	sds	buffer,
		struct t_stickerdb_state *	stickerdb,
		enum mympd_sticker_type	type,
		const char *	uri,
		const struct t_stickers *	stickers
	)

Gets the stickers from stickerdb and returns a json list. Shortcut for stickerdb_get_all_batch and print_sticker. You must exit the stickerdb idle mode before.

Parameters

buffer	already allocated sds string to append the list
stickerdb	pointer to stickerdb
type	MPD sticker type
uri	song uri
stickers	stickers to print

Returns

pointer to the modified buffer

mympd_api_sticker_list()

sds mympd_api_sticker_list	(	struct t_stickerdb_state *	stickerdb,
		sds	buffer,
		unsigned	request_id,
		sds	uri,
		enum mympd_sticker_type	type
	)

Gets all MPD stickers for an uri.

Parameters

stickerdb	pointer to stickerdb
buffer	already allocated sds string to append the list
request_id	jsonrpc request id
uri	Sticker uri
type	MPD sticker type

Returns

Pointer to buffer

mympd_api_sticker_names()

sds mympd_api_sticker_names	(	struct t_stickerdb_state *	stickerdb,
		sds	buffer,
		unsigned	request_id,
		sds	searchstr,
		enum mympd_sticker_type	type
	)

Lists user defined sticker names by type

Parameters

stickerdb	Pointer to stickerdb
buffer	Already allocated sds string to append the list
request_id	jsonrpc request id
searchstr	Search string
type	MPD sticker type

Returns

Pointer to buffer

mympd_api_sticker_print()

sds mympd_api_sticker_print	(	sds	buffer,
		struct t_sticker *	sticker,
		const struct t_stickers *	stickers
	)

Print the sticker struct as json list

Parameters

buffer	already allocated sds string to append the list
sticker	pointer to sticker struct to print
stickers	array of stickers to print

Returns

pointer to the modified buffer

mympd_api_sticker_print_types()

sds mympd_api_sticker_print_types	(	struct t_stickerdb_state *	stickerdb,
		sds	buffer
	)

Print the sticker types as json array

Parameters

stickerdb	Pointer to stickerdb
buffer	already allocated sds string to append the list

Returns

Pointer to buffer

mympd_api_sticker_set_feedback()

bool mympd_api_sticker_set_feedback	(	struct t_stickerdb_state *	stickerdb,
		struct t_list *	trigger_list,
		const char *	partition_name,
		enum mympd_sticker_type	sticker_type,
		sds	uri,
		enum mympd_feedback_type	feedback_type,
		int	value,
		sds *	error
	)

Sets the like sticker and triggers the feedback event

Parameters

stickerdb	pointer to stickerdb
trigger_list	pointer to trigger list
partition_name	the partition name
sticker_type	MPD sticker type
uri	uri to set the feedback
feedback_type	feedback type
value	feedback value to set
error	already allocated sds string to append the error message

Returns

true on success, else false