1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
|
// SPDX-License-Identifier: BSD-2-Clause
// Copyright The Music Player Daemon Project
/*! \file
* \brief MPD client library
*
* Manipulate the queue (current playlist).
*
* Do not include this header directly. Use mpd/client.h instead.
*/
#ifndef MPD_QUEUE_H
#define MPD_QUEUE_H
#include "compiler.h"
#include "position.h"
#include "tag.h"
#include <stdbool.h>
struct mpd_connection;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Consult mpd/playlist.h for the rationale on the preference of manipulating
* song ids over positions in the queue.
*/
/**
* Sends the "playlistinfo" command: list all songs in the queue
* including meta information.
* Use mpd_recv_entity() to receive the songs (#MPD_ENTITY_TYPE_SONG).
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_list_queue_meta(struct mpd_connection *connection);
/**
* Like mpd_send_list_queue_meta(), but specifies a (position) range.
* Use mpd_recv_entity() to receive the songs (#MPD_ENTITY_TYPE_SONG).
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_send_list_queue_range_meta(struct mpd_connection *connection,
unsigned start, unsigned end);
/**
* Requests information (including tags) about one song in the
* playlist (command "playlistid").
* Use mpd_recv_song() to obtain the song information.
*
* @param connection the connection to MPD
* @param pos the position of the requested song
*/
bool
mpd_send_get_queue_song_pos(struct mpd_connection *connection, unsigned pos);
/**
* Shortcut for mpd_send_get_queue_song_pos() and mpd_recv_song().
*
* @param connection the connection to MPD
* @param pos the position of the requested song
* @return the song at the specified position, or NULL on error
*/
mpd_malloc
struct mpd_song *
mpd_run_get_queue_song_pos(struct mpd_connection *connection, unsigned pos);
/**
* Requests information (including tags) about one song in the
* playlist (command "playlistid").
* Use mpd_recv_song() to obtain the song information.
*
* @param connection the connection to MPD
* @param id the id of the requested song
*/
bool
mpd_send_get_queue_song_id(struct mpd_connection *connection, unsigned id);
/**
* Shortcut for mpd_send_get_queue_song_id() and mpd_recv_song().
*
* @param connection the connection to MPD
* @param id the id of the requested song
* @return the song at the specified id, or NULL on error
*/
mpd_malloc
struct mpd_song *
mpd_run_get_queue_song_id(struct mpd_connection *connection, unsigned id);
/**
* Request the queue changes from MPD since the specified version,
* including tags. The MPD command is called "plchanges".
*
* The current version can be fetched with mpd_status_get_queue_version().
* Use mpd_recv_song() to receive the songs of the new version.
*
* @param connection the connection to MPD
* @param version The playlist version you want the diff with.
* @return true on success, false on error
*/
bool
mpd_send_queue_changes_meta(struct mpd_connection *connection,
unsigned version);
/**
* Same as mpd_send_queue_changes_meta(), but limit the result to a
* range.
*
* The current version can be fetched with mpd_status_get_queue_version().
* Use mpd_recv_song() to receive the songs of the new queue.
*
* @param connection the connection to MPD
* @param version The playlist version you want the diff with.
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.12
*/
bool
mpd_send_queue_changes_meta_range(struct mpd_connection *connection,
unsigned version,
unsigned start, unsigned end);
/**
* A more bandwidth efficient version of the
* mpd_send_queue_changes_meta(). It only returns the position and id
* of changed songs. The MPD command is called "plchangesposid".
*
* Use mpd_recv_queue_change_brief() for the response.
*
* @param connection A valid and connected mpd_connection.
* @param version The playlist version you want the diff with.
* @return true on success, false on error
*/
bool
mpd_send_queue_changes_brief(struct mpd_connection *connection,
unsigned version);
/**
* Same as mpd_send_queue_changes_brief(), but limit the result to a
* range.
*
* Use mpd_recv_queue_change_brief() for the response.
*
* @param connection the connection to MPD
* @param version The playlist version you want the diff with.
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.12
*/
bool
mpd_send_queue_changes_brief_range(struct mpd_connection *connection,
unsigned version,
unsigned start, unsigned end);
/**
* Receives a response element of mpd_send_queue_changes_brief() or
* mpd_send_queue_changes_brief_range().
*
* @param connection A valid and connected mpd_connection.
* @param position_r reference to the position of the changed song
* @param id_r reference to the id of the changed song
* @return true on success, false on error or if there are no more
* changes in this response
*/
bool
mpd_recv_queue_change_brief(struct mpd_connection *connection,
unsigned *position_r, unsigned *id_r);
/**
* Appends a song to the playlist: either a single file or a directory.
*
* @param connection A valid and connected mpd_connection.
* @param uri URI of a song or directory (added recursively)
* @return true on success, false on error
*/
bool
mpd_send_add(struct mpd_connection *connection, const char *uri);
/**
* Shortcut for mpd_send_add() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param uri URI of a song or directory (added recursively)
* @return true on success, false on error
*/
bool
mpd_run_add(struct mpd_connection *connection, const char *uri);
/**
* Inserts a song into the playlist for a given position: either a single file or a directory.
*
* @param connection A valid and connected mpd_connection.
* @param uri URI of a song or directory (added recursively)
* @param to the desired position of the song
* @param whence how to interpret the position parameter
* @return true on success, false on error
*
* @since libmpdclient 2.20
*/
bool
mpd_send_add_whence(struct mpd_connection *connection, const char *uri,
unsigned to, enum mpd_position_whence whence);
/**
* Shortcut for mpd_send_add_whence() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param uri URI of a song or directory (added recursively)
* @param to the desired position of the song
* @param whence how to interpret the position parameter
* @return true on success, false on error
*
* @since libmpdclient 2.20
*/
bool
mpd_run_add_whence(struct mpd_connection *connection, const char *uri,
unsigned to, enum mpd_position_whence whence);
/**
* Appends a song to the playlist. Call mpd_recv_song_id() for its id.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri URI of the song to be added
* @return true on success, false on error
*/
bool
mpd_send_add_id(struct mpd_connection *connection, const char *uri);
/**
* Inserts a song into the playlist for a given position, and returns its id.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri the URI of the song to be added
* @param to the desired position of the song
* @return true on success, false on error
*/
bool
mpd_send_add_id_to(struct mpd_connection *connection, const char *uri,
unsigned to);
/**
* Inserts a song into the playlist for a given position, and returns its id.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri the URI of the song to be added
* @param to the desired position of the song
* @param whence how to interpret the position parameter
* @return true on success, false on error
*
* @since libmpdclient 2.20
*/
bool
mpd_send_add_id_whence(struct mpd_connection *connection, const char *uri,
unsigned to, enum mpd_position_whence whence);
/**
* Returns the id of the new song in the playlist. To be called after
* mpd_send_add_id() or mpd_send_add_id_to().
*
* @param connection the connection to MPD
* @return the new song id, -1 on error or if MPD did not send an id
*/
int
mpd_recv_song_id(struct mpd_connection *connection);
/**
* Executes the "addid" command and reads the response.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri URI of a song to be added
* @return the new song id, -1 on error or if MPD did not send an id
*/
int
mpd_run_add_id(struct mpd_connection *connection, const char *uri);
/**
* Executes the "addid" command and reads the response.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri the URI of the song to be added
* @param to the desired position of the song
* @return the new song id, -1 on error or if MPD did not send an id
*/
int
mpd_run_add_id_to(struct mpd_connection *connection, const char *uri,
unsigned to);
/**
* Executes the "addid" command and reads the response.
* file is always a single file or URL.
*
* @param connection the connection to MPD
* @param uri the URI of the song to be added
* @param to the desired position of the song
* @param whence how to interpret the position parameter
* @return the new song id, -1 on error or if MPD did not send an id
*
* @since libmpdclient 2.20
*/
int
mpd_run_add_id_whence(struct mpd_connection *connection, const char *uri,
unsigned to, enum mpd_position_whence whence);
/**
* Deletes a song from the queue.
*
* @param connection the connection to MPD
* @param pos the position of the song to be deleted
* @return true on success, false on error
*/
bool
mpd_send_delete(struct mpd_connection *connection, unsigned pos);
/**
* Shortcut for mpd_send_delete() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param pos the position of the song to be deleted
* @return true on success, false on error
*/
bool
mpd_run_delete(struct mpd_connection *connection, unsigned pos);
/**
* Deletes songs from the queue.
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_send_delete_range(struct mpd_connection *connection,
unsigned start, unsigned end);
/**
* Shortcut for mpd_send_delete_range() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_run_delete_range(struct mpd_connection *connection,
unsigned start, unsigned end);
/**
* Deletes a song from the queue.
*
* @param connection the connection to MPD
* @param id the id of the song to be deleted
* @return true on success, false on error
*/
bool
mpd_send_delete_id(struct mpd_connection *connection, unsigned id);
/**
* Shortcut for mpd_send_delete_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id the id of the song to be deleted
* @return true on success, false on error
*/
bool
mpd_run_delete_id(struct mpd_connection *connection, unsigned id);
/**
* Shuffles the queue.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_shuffle(struct mpd_connection *connection);
/**
* Shortcut for mpd_send_shuffle() and mpd_response_finish().
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_run_shuffle(struct mpd_connection *connection);
/**
* Shuffles a range within the queue.
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_send_shuffle_range(struct mpd_connection *connection,
unsigned start, unsigned end);
/**
* Shortcut for mpd_send_shuffle_range() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_run_shuffle_range(struct mpd_connection *connection,
unsigned start, unsigned end);
/**
* Clear the queue.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_clear(struct mpd_connection *connection);
/**
* Shortcut for mpd_send_clear() and mpd_response_finish().
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_run_clear(struct mpd_connection *connection);
/**
* Moves a song within the queue.
*
* @param connection the connection to MPD
* @param from the source song position
* @param to the new position of the song
* @return true on success, false on error
*/
bool
mpd_send_move(struct mpd_connection *connection, unsigned from, unsigned to);
/**
* Shortcut for mpd_send_move() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param from the source song position
* @param to the new position of the song
* @return true on success, false on error
*/
bool
mpd_run_move(struct mpd_connection *connection, unsigned from, unsigned to);
/**
* Moves a song within the queue.
*
* @param connection the connection to MPD
* @param from the source song position
* @param to the new position of the song
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_send_move_whence(struct mpd_connection *connection, unsigned from,
unsigned to, enum mpd_position_whence whence);
/**
* Shortcut for mpd_send_move_whence() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param from the source song position
* @param to the new position of the song
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_run_move_whence(struct mpd_connection *connection, unsigned from,
unsigned to, enum mpd_position_whence whence);
/**
* Moves a song within the queue.
*
* @param connection the connection to MPD
* @param from the source song id
* @param to the new position of the song (not an id!)
* @return true on success, false on error
*/
bool
mpd_send_move_id(struct mpd_connection *connection, unsigned from, unsigned to);
/**
* Shortcut for mpd_send_move_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param from the source song id
* @param to the new position of the song (not an id!)
* @return true on success, false on error
*/
bool
mpd_run_move_id(struct mpd_connection *connection, unsigned from, unsigned to);
/**
* Moves a song within the queue.
*
* @param connection the connection to MPD
* @param from the source song id
* @param to the new position of the song (not an id!)
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_send_move_id_whence(struct mpd_connection *connection, unsigned from,
unsigned to, enum mpd_position_whence whence);
/**
* Shortcut for mpd_send_move_id_whence() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param from the source song id
* @param to the new position of the song (not an id!)
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_run_move_id_whence(struct mpd_connection *connection, unsigned from,
unsigned to, enum mpd_position_whence whence);
/**
* Moves a range of songs within the queue.
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @param to the new position of the song range
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_send_move_range(struct mpd_connection *connection,
unsigned start, unsigned end, unsigned to);
/**
* Shortcut for mpd_send_move_range() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @param to the new position of the song range
* @return true on success, false on error
*
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_run_move_range(struct mpd_connection *connection,
unsigned start, unsigned end, unsigned to);
/**
* Moves a range of songs within the queue.
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @param to the new position of the song range
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_send_move_range_whence(struct mpd_connection *connection, unsigned start,
unsigned end, unsigned to, enum mpd_position_whence whence);
/**
* Shortcut for mpd_send_move_range_whence() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @param to the new position of the song range
* @param whence how to interpret the to parameter
* @return true on success, false on error
*
* @since libmpdclient 2.21, MPD 0.23
*/
bool
mpd_run_move_range_whence(struct mpd_connection *connection, unsigned start,
unsigned end, unsigned to, enum mpd_position_whence whence);
/**
* Swap the position of two songs in the queue.
*
* @param connection the connection to MPD
* @param pos1 the position of one song
* @param pos2 the position of the other song
* @return true on success, false on error
*/
bool
mpd_send_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2);
/**
* Shortcut for mpd_send_swap() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param pos1 the position of one song
* @param pos2 the position of the other song
* @return true on success, false on error
*/
bool
mpd_run_swap(struct mpd_connection *connection, unsigned pos1, unsigned pos2);
/**
* Swap the position of two songs in the queue.
*
* @param connection the connection to MPD
* @param id1 the id of one song
* @param id2 the id of the other song
* @return true on success, false on error
*/
bool
mpd_send_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2);
/**
* Shortcut for mpd_send_swap_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id1 the id of one song
* @param id2 the id of the other song
* @return true on success, false on error
*/
bool
mpd_run_swap_id(struct mpd_connection *connection, unsigned id1, unsigned id2);
/**
* Adds a tag to the specified song (command "addtagid").
*
* @param connection the connection to MPD
* @param id the id of the song
* @param tag the tag to be added
* @param value the tag value
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_send_add_tag_id(struct mpd_connection *connection, unsigned id,
enum mpd_tag_type tag, const char *value);
/**
* Shortcut for mpd_send_add_tag_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id the id of the song
* @param tag the tag to be added
* @param value the tag value
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_run_add_tag_id(struct mpd_connection *connection, unsigned id,
enum mpd_tag_type tag, const char *value);
/**
* Remove a tag from the specified song (command "cleartagid").
*
* @param connection the connection to MPD
* @param id the id of the song
* @param tag the tag to be cleared
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_send_clear_tag_id(struct mpd_connection *connection, unsigned id,
enum mpd_tag_type tag);
/**
* Shortcut for mpd_send_clear_tag_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id the id of the song
* @param tag the tag to be cleared
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_run_clear_tag_id(struct mpd_connection *connection, unsigned id,
enum mpd_tag_type tag);
/**
* Remove all tags from the specified song (command "cleartagid").
*
* @param connection the connection to MPD
* @param id the id of the song
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_send_clear_all_tags_id(struct mpd_connection *connection, unsigned id);
/**
* Shortcut for mpd_send_clear_all_tags_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id the id of the song
* @return true on success, false on error
*
* @since libmpdclient 2.12, MPD 0.19
*/
bool
mpd_run_clear_all_tags_id(struct mpd_connection *connection, unsigned id);
/**
* Change the priority of the specified song.
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param position the position of the song
* @return true on success, false on error
*
* @since libmpdclient 2.6
*/
bool
mpd_send_prio(struct mpd_connection *connection, unsigned priority,
unsigned position);
/**
* Shortcut for mpd_send_prio() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param position the position of the song
* @return true on success, false on error
*
* @since libmpdclient 2.6
*/
bool
mpd_run_prio(struct mpd_connection *connection, unsigned priority,
unsigned position);
/**
* Change the priority of a song range.
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.6
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_send_prio_range(struct mpd_connection *connection, unsigned priority,
unsigned start, unsigned end);
/**
* Shortcut for mpd_send_prio_range() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param start the start position of the range (including)
* @param end the end position of the range (excluding); the special
* value "UINT_MAX" makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.6
* @since libmpdclient 2.8 added support for "UINT_MAX"
*/
bool
mpd_run_prio_range(struct mpd_connection *connection, unsigned priority,
unsigned start, unsigned end);
/**
* Change the priority of the specified song.
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param id the id of the song
* @return true on success, false on error
*
* @since libmpdclient 2.6
*/
bool
mpd_send_prio_id(struct mpd_connection *connection, unsigned priority,
unsigned id);
/**
* Shortcut for mpd_send_prio_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param priority a number between 0 and 255
* @param id the id of the song
* @return true on success, false on error
*
* @since libmpdclient 2.6
*/
bool
mpd_run_prio_id(struct mpd_connection *connection, unsigned priority,
unsigned id);
/**
* Specify the portion of a song that shall be played.
* The song is identified by its id and cannot be the currently playing song.
*
* The start/end values are offsets in seconds (fractional seconds allowed);
* both are optional.
*
* @param connection the connection to MPD
* @param id the id of the song (cannot be the currently playing song)
* @param start the offset in seconds for starting the song
* @param end the offset in seconds for ending the song; a negative
* value makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.19, MPD 0.20
*/
bool
mpd_send_range_id(struct mpd_connection *connection, unsigned id,
float start, float end);
/**
*
* Shortcut for mpd_send_range_id() and mpd_response_finish().
*
* @param connection the connection to MPD
* @param id the id of the song (cannot be the currently playing song)
* @param start the offset in seconds for starting the song
* @param end the offset in seconds for ending the song; a negative
* value makes the end of the range open
* @return true on success, false on error
*
* @since libmpdclient 2.19, MPD 0.20
*/
bool
mpd_run_range_id(struct mpd_connection *connection, unsigned id,
float start, float end);
#ifdef __cplusplus
}
#endif
#endif
|