libmpdclient  2.22
queue.h
Go to the documentation of this file.
1 // SPDX-License-Identifier: BSD-2-Clause
2 // Copyright The Music Player Daemon Project
3 
12 #ifndef MPD_QUEUE_H
13 #define MPD_QUEUE_H
14 
15 #include "compiler.h"
16 #include "position.h"
17 #include "tag.h"
18 
19 #include <stdbool.h>
20 
21 struct mpd_connection;
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
40 bool
41 mpd_send_list_queue_meta(struct mpd_connection *connection);
42 
55 bool
57  unsigned start, unsigned end);
58 
67 bool
68 mpd_send_get_queue_song_pos(struct mpd_connection *connection, unsigned pos);
69 
77 mpd_malloc
78 struct mpd_song *
79 mpd_run_get_queue_song_pos(struct mpd_connection *connection, unsigned pos);
80 
89 bool
90 mpd_send_get_queue_song_id(struct mpd_connection *connection, unsigned id);
91 
99 mpd_malloc
100 struct mpd_song *
101 mpd_run_get_queue_song_id(struct mpd_connection *connection, unsigned id);
102 
114 bool
116  unsigned version);
117 
134 bool
136  unsigned version,
137  unsigned start, unsigned end);
138 
150 bool
152  unsigned version);
153 
169 bool
171  unsigned version,
172  unsigned start, unsigned end);
173 
184 bool
186  unsigned *position_r, unsigned *id_r);
187 
195 bool
196 mpd_send_add(struct mpd_connection *connection, const char *uri);
197 
205 bool
206 mpd_run_add(struct mpd_connection *connection, const char *uri);
207 
219 bool
220 mpd_send_add_whence(struct mpd_connection *connection, const char *uri,
221  unsigned to, enum mpd_position_whence whence);
222 
234 bool
235 mpd_run_add_whence(struct mpd_connection *connection, const char *uri,
236  unsigned to, enum mpd_position_whence whence);
237 
246 bool
247 mpd_send_add_id(struct mpd_connection *connection, const char *uri);
248 
258 bool
259 mpd_send_add_id_to(struct mpd_connection *connection, const char *uri,
260  unsigned to);
261 
274 bool
275 mpd_send_add_id_whence(struct mpd_connection *connection, const char *uri,
276  unsigned to, enum mpd_position_whence whence);
277 
285 int
286 mpd_recv_song_id(struct mpd_connection *connection);
287 
296 int
297 mpd_run_add_id(struct mpd_connection *connection, const char *uri);
298 
308 int
309 mpd_run_add_id_to(struct mpd_connection *connection, const char *uri,
310  unsigned to);
311 
324 int
325 mpd_run_add_id_whence(struct mpd_connection *connection, const char *uri,
326  unsigned to, enum mpd_position_whence whence);
327 
335 bool
336 mpd_send_delete(struct mpd_connection *connection, unsigned pos);
337 
345 bool
346 mpd_run_delete(struct mpd_connection *connection, unsigned pos);
347 
359 bool
360 mpd_send_delete_range(struct mpd_connection *connection,
361  unsigned start, unsigned end);
362 
374 bool
375 mpd_run_delete_range(struct mpd_connection *connection,
376  unsigned start, unsigned end);
377 
385 bool
386 mpd_send_delete_id(struct mpd_connection *connection, unsigned id);
387 
395 bool
396 mpd_run_delete_id(struct mpd_connection *connection, unsigned id);
397 
404 bool
405 mpd_send_shuffle(struct mpd_connection *connection);
406 
413 bool
414 mpd_run_shuffle(struct mpd_connection *connection);
415 
427 bool
428 mpd_send_shuffle_range(struct mpd_connection *connection,
429  unsigned start, unsigned end);
430 
442 bool
443 mpd_run_shuffle_range(struct mpd_connection *connection,
444  unsigned start, unsigned end);
445 
452 bool
453 mpd_send_clear(struct mpd_connection *connection);
454 
461 bool
462 mpd_run_clear(struct mpd_connection *connection);
463 
472 bool
473 mpd_send_move(struct mpd_connection *connection, unsigned from, unsigned to);
474 
483 bool
484 mpd_run_move(struct mpd_connection *connection, unsigned from, unsigned to);
485 
497 bool
498 mpd_send_move_whence(struct mpd_connection *connection, unsigned from,
499  unsigned to, enum mpd_position_whence whence);
500 
512 bool
513 mpd_run_move_whence(struct mpd_connection *connection, unsigned from,
514  unsigned to, enum mpd_position_whence whence);
515 
524 bool
525 mpd_send_move_id(struct mpd_connection *connection, unsigned from, unsigned to);
526 
535 bool
536 mpd_run_move_id(struct mpd_connection *connection, unsigned from, unsigned to);
537 
549 bool
550 mpd_send_move_id_whence(struct mpd_connection *connection, unsigned from,
551  unsigned to, enum mpd_position_whence whence);
552 
564 bool
565 mpd_run_move_id_whence(struct mpd_connection *connection, unsigned from,
566  unsigned to, enum mpd_position_whence whence);
567 
580 bool
581 mpd_send_move_range(struct mpd_connection *connection,
582  unsigned start, unsigned end, unsigned to);
583 
596 bool
597 mpd_run_move_range(struct mpd_connection *connection,
598  unsigned start, unsigned end, unsigned to);
599 
613 bool
614 mpd_send_move_range_whence(struct mpd_connection *connection, unsigned start,
615  unsigned end, unsigned to, enum mpd_position_whence whence);
616 
630 bool
631 mpd_run_move_range_whence(struct mpd_connection *connection, unsigned start,
632  unsigned end, unsigned to, enum mpd_position_whence whence);
633 
642 bool
643 mpd_send_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2);
644 
653 bool
654 mpd_run_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2);
655 
664 bool
665 mpd_send_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2);
666 
675 bool
676 mpd_run_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2);
677 
689 bool
690 mpd_send_add_tag_id(struct mpd_connection *connection, unsigned id,
691  enum mpd_tag_type tag, const char *value);
692 
704 bool
705 mpd_run_add_tag_id(struct mpd_connection *connection, unsigned id,
706  enum mpd_tag_type tag, const char *value);
707 
718 bool
719 mpd_send_clear_tag_id(struct mpd_connection *connection, unsigned id,
720  enum mpd_tag_type tag);
721 
732 bool
733 mpd_run_clear_tag_id(struct mpd_connection *connection, unsigned id,
734  enum mpd_tag_type tag);
735 
745 bool
746 mpd_send_clear_all_tags_id(struct mpd_connection *connection, unsigned id);
747 
757 bool
758 mpd_run_clear_all_tags_id(struct mpd_connection *connection, unsigned id);
759 
770 bool
771 mpd_send_prio(struct mpd_connection *connection, unsigned priority,
772  unsigned position);
773 
784 bool
785 mpd_run_prio(struct mpd_connection *connection, unsigned priority,
786  unsigned position);
787 
801 bool
802 mpd_send_prio_range(struct mpd_connection *connection, unsigned priority,
803  unsigned start, unsigned end);
804 
818 bool
819 mpd_run_prio_range(struct mpd_connection *connection, unsigned priority,
820  unsigned start, unsigned end);
821 
832 bool
833 mpd_send_prio_id(struct mpd_connection *connection, unsigned priority,
834  unsigned id);
835 
846 bool
847 mpd_run_prio_id(struct mpd_connection *connection, unsigned priority,
848  unsigned id);
849 
866 bool
867 mpd_send_range_id(struct mpd_connection *connection, unsigned id,
868  float start, float end);
869 
883 bool
884 mpd_run_range_id(struct mpd_connection *connection, unsigned id,
885  float start, float end);
886 #ifdef __cplusplus
887 }
888 #endif
889 
890 #endif
bool mpd_run_add(struct mpd_connection *connection, const char *uri)
bool mpd_send_add_id(struct mpd_connection *connection, const char *uri)
bool mpd_send_delete_id(struct mpd_connection *connection, unsigned id)
bool mpd_send_move_id_whence(struct mpd_connection *connection, unsigned from, unsigned to, enum mpd_position_whence whence)
bool mpd_run_delete_range(struct mpd_connection *connection, unsigned start, unsigned end)
bool mpd_send_move_range(struct mpd_connection *connection, unsigned start, unsigned end, unsigned to)
bool mpd_send_list_queue_meta(struct mpd_connection *connection)
bool mpd_send_list_queue_range_meta(struct mpd_connection *connection, unsigned start, unsigned end)
bool mpd_run_shuffle_range(struct mpd_connection *connection, unsigned start, unsigned end)
bool mpd_send_clear_all_tags_id(struct mpd_connection *connection, unsigned id)
bool mpd_send_move_id(struct mpd_connection *connection, unsigned from, unsigned to)
bool mpd_send_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2)
bool mpd_run_prio_id(struct mpd_connection *connection, unsigned priority, unsigned id)
bool mpd_send_queue_changes_brief_range(struct mpd_connection *connection, unsigned version, unsigned start, unsigned end)
bool mpd_send_get_queue_song_id(struct mpd_connection *connection, unsigned id)
bool mpd_run_range_id(struct mpd_connection *connection, unsigned id, float start, float end)
mpd_tag_type
Definition: tag.h:24
bool mpd_run_move_whence(struct mpd_connection *connection, unsigned from, unsigned to, enum mpd_position_whence whence)
bool mpd_send_shuffle(struct mpd_connection *connection)
bool mpd_run_move(struct mpd_connection *connection, unsigned from, unsigned to)
bool mpd_send_range_id(struct mpd_connection *connection, unsigned id, float start, float end)
bool mpd_run_prio_range(struct mpd_connection *connection, unsigned priority, unsigned start, unsigned end)
bool mpd_send_move_whence(struct mpd_connection *connection, unsigned from, unsigned to, enum mpd_position_whence whence)
bool mpd_send_prio(struct mpd_connection *connection, unsigned priority, unsigned position)
bool mpd_run_shuffle(struct mpd_connection *connection)
bool mpd_send_add_id_whence(struct mpd_connection *connection, const char *uri, unsigned to, enum mpd_position_whence whence)
bool mpd_run_move_id(struct mpd_connection *connection, unsigned from, unsigned to)
bool mpd_send_prio_range(struct mpd_connection *connection, unsigned priority, unsigned start, unsigned end)
bool mpd_recv_queue_change_brief(struct mpd_connection *connection, unsigned *position_r, unsigned *id_r)
bool mpd_send_get_queue_song_pos(struct mpd_connection *connection, unsigned pos)
int mpd_recv_song_id(struct mpd_connection *connection)
bool mpd_run_add_tag_id(struct mpd_connection *connection, unsigned id, enum mpd_tag_type tag, const char *value)
bool mpd_send_queue_changes_meta_range(struct mpd_connection *connection, unsigned version, unsigned start, unsigned end)
bool mpd_run_clear_all_tags_id(struct mpd_connection *connection, unsigned id)
int mpd_run_add_id_whence(struct mpd_connection *connection, const char *uri, unsigned to, enum mpd_position_whence whence)
bool mpd_run_clear_tag_id(struct mpd_connection *connection, unsigned id, enum mpd_tag_type tag)
int mpd_run_add_id(struct mpd_connection *connection, const char *uri)
bool mpd_send_queue_changes_brief(struct mpd_connection *connection, unsigned version)
bool mpd_run_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2)
bool mpd_send_add(struct mpd_connection *connection, const char *uri)
bool mpd_run_move_id_whence(struct mpd_connection *connection, unsigned from, unsigned to, enum mpd_position_whence whence)
bool mpd_run_delete(struct mpd_connection *connection, unsigned pos)
bool mpd_run_prio(struct mpd_connection *connection, unsigned priority, unsigned position)
bool mpd_run_move_range(struct mpd_connection *connection, unsigned start, unsigned end, unsigned to)
bool mpd_send_move(struct mpd_connection *connection, unsigned from, unsigned to)
bool mpd_send_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2)
bool mpd_run_delete_id(struct mpd_connection *connection, unsigned id)
bool mpd_send_shuffle_range(struct mpd_connection *connection, unsigned start, unsigned end)
bool mpd_run_clear(struct mpd_connection *connection)
bool mpd_send_delete_range(struct mpd_connection *connection, unsigned start, unsigned end)
bool mpd_send_add_id_to(struct mpd_connection *connection, const char *uri, unsigned to)
Definition: song.h:20
struct mpd_song * mpd_run_get_queue_song_id(struct mpd_connection *connection, unsigned id)
MPD client library.
bool mpd_send_prio_id(struct mpd_connection *connection, unsigned priority, unsigned id)
int mpd_run_add_id_to(struct mpd_connection *connection, const char *uri, unsigned to)
bool mpd_run_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2)
bool mpd_send_clear(struct mpd_connection *connection)
bool mpd_send_clear_tag_id(struct mpd_connection *connection, unsigned id, enum mpd_tag_type tag)
bool mpd_send_add_whence(struct mpd_connection *connection, const char *uri, unsigned to, enum mpd_position_whence whence)
bool mpd_send_move_range_whence(struct mpd_connection *connection, unsigned start, unsigned end, unsigned to, enum mpd_position_whence whence)
bool mpd_send_queue_changes_meta(struct mpd_connection *connection, unsigned version)
bool mpd_run_move_range_whence(struct mpd_connection *connection, unsigned start, unsigned end, unsigned to, enum mpd_position_whence whence)
bool mpd_send_delete(struct mpd_connection *connection, unsigned pos)
struct mpd_song * mpd_run_get_queue_song_pos(struct mpd_connection *connection, unsigned pos)
mpd_position_whence
Definition: position.h:13
bool mpd_run_add_whence(struct mpd_connection *connection, const char *uri, unsigned to, enum mpd_position_whence whence)
bool mpd_send_add_tag_id(struct mpd_connection *connection, unsigned id, enum mpd_tag_type tag, const char *value)