/usr/include/xmms2/xmmsclient/xmmsclient++/playlist.h is in libxmmsclient++-dev 0.8+dfsg-14build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* XMMS2 - X Music Multiplexer System
* Copyright (C) 2003-2011 XMMS2 Team
*
* PLUGINS ARE NOT CONSIDERED TO BE DERIVED WORK !!!
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
#ifndef XMMSCLIENTPP_PLAYLIST_HH
#define XMMSCLIENTPP_PLAYLIST_HH
#include <xmmsclient/xmmsclient.h>
#include <xmmsclient/xmmsclient++/mainloop.h>
#include <xmmsclient/xmmsclient++/result.h>
#include <xmmsclient/xmmsclient++/coll.h>
#include <string>
#include <list>
namespace Xmms
{
class Client;
/** @class Playlist playlist.h "xmmsclient/xmmsclient++/playlist.h"
* @brief This class controls the playlist
*/
class Playlist
{
public:
static const std::string DEFAULT_PLAYLIST;
/** Destructor.
* Doesn't really do anything at this moment :)
*/
virtual ~Playlist();
/** Get the list of saved playlists.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
StringListResult list() const;
/** Create a new empty playlist.
*
* @param playlist the name of the playlist to create.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult create( const std::string& playlist ) const;
/** Load a saved playlist and make it the active playlist.
*
* @param playlist the playlist to load.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult load( const std::string& playlist ) const;
/** Add the url to a playlist.
* The url should be absolute to the server-side.
* Note that you will have to include the protocol
* for the url to. ie: file://mp3/my_mp3s/first.mp3.
*
* @param url file to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addUrl( const std::string& url,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Add the url with arguments to a playlist.
* The url should be absolute to the server-side.
* Note that you will have to include the protocol
* for the url to. ie: file://mp3/my_mp3s/first.mp3.
*
* @param url file to be added
* @param args List of strings used as arguments.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addUrl( const std::string& url,
const std::list< std::string>& args,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Add the url to a playlist.
* Same as #addUrl but takes an encoded URL instead
*
* @param url file to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addUrlEncoded( const std::string& url,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Add the directory recursively to a playlist.
* The url should be absolute to the server-side.
* Note that you will have to include the protocol
* for the url to. ie: file://mp3/my_mp3s/directory
*
* @param url directory to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addRecursive( const std::string& url,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Add the directory recursivly to a playlist.
* Same as #addRecursive but takes a encoded URL instead.
*
* @param url directory to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addRecursiveEncoded( const std::string& url,
const std::string& playlist
= DEFAULT_PLAYLIST
) const;
/** Add a medialib id to a playlist.
*
* @param id A medialib ID
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addId( const int id,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Add an idlist to a playlist.
*
* @param idlist an ID list
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
* @throw std::bad_cast If idlist is not a valid const Coll::Idlist&.
*/
VoidResult addIdlist( const Coll::Coll& idlist,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Add the content of the given collection to a playlist.
* The list of ordering properties defines how the set of
* matching media is added.
*
* @param collection The collection from which media will
* be added to the playlist.
* @param order The order in which the matched media are added.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addCollection( const Coll::Coll& collection,
const std::list< std::string >& order,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Clears a playlist.
*
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult clear( const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Retrieve the current position in a playlist.
*
* @param playlist the playlist to consider (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*
* @return Dict containing then name of a playlist in 'name' and
* the current position in that playlist as integer in 'position'.
*/
DictResult currentPos( const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Retrieve the name of the current active playlist.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*
* @return current position as integer.
*/
StringResult currentActive() const;
/** Insert an entry at given position in a playlist.
*
* @param pos A position in the playlist.
* @param url The URL to insert.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertUrl( int pos, const std::string& url,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Insert an entry with args at given position in a playlist.
*
* @param pos A position in the playlist.
* @param url The URL to insert.
* @param args List of strings used as arguments.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertUrl( int pos, const std::string& url,
const std::list< std::string >& args,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Insert an entry at given position in a playlist.
* Same as #insertUrl but takes a encoded url instead.
*
* @param pos A position in the playlist.
* @param url The URL to insert.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertUrlEncoded( int pos, const std::string& url,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Insert a medialib ID at given position in a playlist.
*
* @param pos A position in the playlist.
* @param id A medialib ID.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertId( int pos, int id,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Add the content of the given collection to a playlist.
* The list of ordering properties defines how the set of
* matching media is added.
*
* @param pos A position in the playlist.
* @param collection The collection from which media will
* be added to the playlist.
* @param order The order in which the matched media are added.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertCollection( int pos, const Coll::Coll& collection,
const std::list< std::string >& order,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Insert the directory recursively at a given position in a
* playlist.
* The url should be absolute to the server-side.
* Note that you will have to include the protocol
* for the url to. ie: file://mp3/my_mp3s/directory
*
* @param pos A position in the playlist.
* @param url directory to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertRecursive( int pos, const std::string& url,
const std::string& playlist
= DEFAULT_PLAYLIST
) const;
/** Insert the directory recursivly at a given position in a
* playlist.
* Same as #insertRecursive but takes a encoded URL instead.
*
* @param pos A position in the playlist.
* @param url directory to be added
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult insertRecursiveEncoded( int pos, const std::string& url,
const std::string& playlist
= DEFAULT_PLAYLIST
) const;
/** Retrieve the entries in a playlist.
*
* @param playlist the playlist to consider (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*
* @return A List of medialib IDs
*/
IntListResult listEntries( const std::string& playlist
= DEFAULT_PLAYLIST ) const;
/** Move a playlist entry to a new position (absolute move).
*
* @param curpos Position of the entry to be moved.
* @param newpos Position where the entry should be moved to.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult moveEntry( int curpos, int newpos,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Remove an entry from a playlist.
*
* @param pos The position that should be
* removed from the playlist.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult removeEntry( int pos,
const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Removes a playlist.
*
* @param playlist the playlist to remove.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult remove( const std::string& playlist ) const;
/** Set next entry in the playlist.
*
* @param pos A position to jump to.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
IntResult setNext( int pos ) const;
/** Same as setNext but relative to the current position.
*
* -1 will back one and 1 will move to the next entry.
*
* @param pos Relative position for the jump.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
IntResult setNextRel( signed int pos ) const;
/** Shuffles a playlist.
*
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult shuffle( const std::string& playlist = DEFAULT_PLAYLIST
) const;
/** Sorts a playlist according to a list of properties.
*
* @param properties Properties to sort by.
* @param playlist the playlist to modify (if omitted,
* act on the current playlist)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult sort( const std::list<std::string>& properties,
const std::string& playlist = DEFAULT_PLAYLIST ) const;
/** Request the playlist changed broadcast from the server.
*
* Everytime someone manipulates the playlist this will be emitted.
*
* @param slot Function pointer to a function taking a
* const Dict& and returning a bool.
* @param error Function pointer to an error callback
* function. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
*/
DictSignal broadcastChanged() const;
/** Request the playlist current position broadcast.
*
* When the position in the playlist is
* changed this will be called.
*
* @param slot Function pointer to a function taking a
* const Dict& and returning a bool.
* Dict contains then name of a playlist
* in 'name' and the updated position in
* that playlist as integer in 'position'.
* @param error Function pointer to an error callback
* function. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
*/
DictSignal broadcastCurrentPos() const;
/** Request the playlist loaded broadcast from the server.
*
* Everytime someone loads a saved playlist this will be emitted.
*
* @param slot Function pointer to a function taking a
* const string& and returning a bool.
* @param error Function pointer to an error callback
* function. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
*/
StringSignal broadcastLoaded() const;
/** @cond */
private:
friend class Client;
Playlist( xmmsc_connection_t*& conn, bool& connected,
MainloopInterface*& ml );
Playlist( const Playlist& src );
Playlist& operator=( const Playlist& src );
xmmsc_connection_t*& conn_;
bool& connected_;
MainloopInterface*& ml_;
/** @endcond */
};
}
#endif // XMMSCLIENTPP_PLAYLIST_HH
|