jukebox.h File Reference

myMPD jukebox API More...

#include "src/lib/api.h"
#include "src/lib/mympd_state.h"

Include dependency graph for jukebox.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	mympd_api_jukebox_clear (struct t_list *list, sds partition_name)
bool	mympd_api_jukebox_rm_entries (struct t_list *list, struct t_list *positions, sds partition_name, sds *error)
sds	mympd_api_jukebox_list (struct t_partition_state *partition_state, struct t_stickerdb_state *stickerdb, struct t_cache *album_cache, sds buffer, enum mympd_cmd_ids cmd_id, unsigned request_id, unsigned offset, unsigned limit, sds expression, const struct t_fields *tagcols)
sds	mympd_api_jukebox_length (struct t_partition_state *partition_state, sds buffer, enum mympd_cmd_ids cmd_id, unsigned request_id)
bool	mympd_api_jukebox_append_uris (struct t_partition_state *partition_state, struct t_list *uris)

Detailed Description

myMPD jukebox API

Function Documentation

mympd_api_jukebox_append_uris()

bool mympd_api_jukebox_append_uris	(	struct t_partition_state *	partition_state,
		struct t_list *	uris
	)

Appends songs the the jukebox queue. This is only allowed in jukebox script mode.

Parameters

partition_state	pointer to myMPD partition state
uris	list of uris to add

Returns

true on success, else false

mympd_api_jukebox_clear()

void mympd_api_jukebox_clear	(	struct t_list *	list,
		sds	partition_name
	)

Clears the jukebox queue. This is a simple wrapper around list_clear.

Parameters

partition_name	name of the partition
list	the jukebox queue

mympd_api_jukebox_length()

sds mympd_api_jukebox_length	(	struct t_partition_state *	partition_state,
		sds	buffer,
		enum mympd_cmd_ids	cmd_id,
		unsigned	request_id
	)

Returns the length of the jukebox queue

Parameters

partition_state	pointer to myMPD partition state
buffer	already allocated sds string to append the result
cmd_id	jsonrpc method
request_id	jsonrpc request id

Returns

pointer to buffer

mympd_api_jukebox_list()

sds mympd_api_jukebox_list	(	struct t_partition_state *	partition_state,
		struct t_stickerdb_state *	stickerdb,
		struct t_cache *	album_cache,
		sds	buffer,
		enum mympd_cmd_ids	cmd_id,
		unsigned	request_id,
		unsigned	offset,
		unsigned	limit,
		sds	expression,
		const struct t_fields *	tagcols
	)

Prints the jukebox queue as an jsonrpc response

Parameters

partition_state	pointer to myMPD partition state
stickerdb	pointer to stickerdb state
album_cache	Pointer to album cache
buffer	already allocated sds string to append the result
cmd_id	jsonrpc method
request_id	jsonrpc request id
offset	offset for printing
limit	max entries to print
expression	mpd search expression
tagcols	columns to print

Returns

pointer to buffer

mympd_api_jukebox_rm_entries()

bool mympd_api_jukebox_rm_entries	(	struct t_list *	list,
		struct t_list *	positions,
		sds	partition_name,
		sds *	error
	)

Removes entries from the jukebox queue.

Parameters

list	the jukebox queue
positions	positions to remove
partition_name	name of the partition
error	pointer to sds string to populate an error string

Returns

true on success, else false