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 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "AddonClass.h"
#include <vector>
namespace MUSIC_INFO
{
class CMusicInfoTag;
}
namespace XBMCAddon
{
namespace xbmc
{
//
/// \defgroup python_InfoTagMusic InfoTagMusic
/// \ingroup python_xbmc
/// @{
/// @brief **Kodi's music info tag class.**
///
/// \python_class{ xbmc.InfoTagMusic([offscreen]) }
///
/// Access and / or modify the music metadata of a ListItem.
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// tag = xbmc.Player().getMusicInfoTag()
///
/// title = tag.getTitle()
/// url = tag.getURL()
/// ...
/// ~~~~~~~~~~~~~
//
class InfoTagMusic : public AddonClass
{
private:
MUSIC_INFO::CMusicInfoTag* infoTag;
bool offscreen;
bool owned;
public:
#ifndef SWIG
explicit InfoTagMusic(const MUSIC_INFO::CMusicInfoTag* tag);
explicit InfoTagMusic(MUSIC_INFO::CMusicInfoTag* tag, bool offscreen = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ xbmc.InfoTagMusic([offscreen]) }
/// Create a music info tag.
///
/// @param offscreen [opt] bool (default `False`) - if GUI based locks should be
/// avoided. Most of the times listitems are created
/// offscreen and added later to a container
/// for display (e.g. plugins) or they are not
/// even displayed (e.g. python scrapers).
/// In such cases, there is no need to lock the
/// GUI when creating the items (increasing your addon
/// performance).
/// Note however, that if you are creating listitems
/// and managing the container itself (e.g using
/// WindowXML or WindowXMLDialog classes) subsquent
/// modifications to the item will require locking.
/// Thus, in such cases, use the default value (`False`).
///
///
///-----------------------------------------------------------------------
/// @python_v20 Added **offscreen** argument.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ...
/// musicinfo = xbmc.InfoTagMusic(offscreen=False)
/// ...
/// ~~~~~~~~~~~~~
///
InfoTagMusic(...);
#else
explicit InfoTagMusic(bool offscreen = false);
#endif
~InfoTagMusic() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getDbId() }
/// Get identification number of tag in database.
///
/// @return [integer] database id.
///
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getDbId();
#else
int getDbId();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getURL() }
/// Returns url of source as string from music info tag.
///
/// @return [string] Url of source
///
///
///-----------------------------------------------------------------------
///
///
getURL();
#else
String getURL();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getTitle() }
/// Returns the title from music as string on info tag.
///
/// @return [string] Music title
///
///
///-----------------------------------------------------------------------
///
///
getTitle();
#else
String getTitle();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMediaType() }
/// Get the media type of the music item.
///
/// @return [string] media type
///
/// Available strings about media type for music:
/// | String | Description |
/// |---------------:|:--------------------------------------------------|
/// | artist | If it is defined as an artist
/// | album | If it is defined as an album
/// | song | If it is defined as a song
///
///-----------------------------------------------------------------------
/// @python_v18 New function added.
///
getMediaType();
#else
String getMediaType();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getArtist() }
/// Returns the artist from music as string if present.
///
/// @return [string] Music artist
///
///
///-----------------------------------------------------------------------
///
///
getArtist();
#else
String getArtist();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getAlbum() }
/// Returns the album from music tag as string if present.
///
/// @return [string] Music album name
///
///
///-----------------------------------------------------------------------
///
///
getAlbum();
#else
String getAlbum();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getAlbumArtist() }
/// Returns the album artist from music tag as string if present.
///
/// @return [string] Music album artist name
///
///
///-----------------------------------------------------------------------
///
///
getAlbumArtist();
#else
String getAlbumArtist();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getGenre() }
/// Returns the genre name from music tag as string if present.
///
/// @return [string] Genre name
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getGenres()** instead.
///
getGenre();
#else
String getGenre();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getGenres() }
/// Returns the list of genres from music tag if present.
///
/// @return [list] List of genres
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getGenres();
#else
std::vector<String> getGenres();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getDuration() }
/// Returns the duration of music as integer from info tag.
///
/// @return [integer] Duration
///
///
///-----------------------------------------------------------------------
///
///
getDuration();
#else
int getDuration();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getYear() }
/// Returns the year of music as integer from info tag.
///
/// @return [integer] Year
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
///
getYear();
#else
int getYear();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getRating() }
/// Returns the scraped rating as integer.
///
/// @return [integer] Rating
///
///
///-----------------------------------------------------------------------
///
///
getRating();
#else
int getRating();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getUserRating() }
/// Returns the user rating as integer (-1 if not existing)
///
/// @return [integer] User rating
///
///
///-----------------------------------------------------------------------
///
///
getUserRating();
#else
int getUserRating();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getTrack() }
/// Returns the track number (if present) from music info tag as integer.
///
/// @return [integer] Track number
///
///
///-----------------------------------------------------------------------
///
///
getTrack();
#else
int getTrack();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getDisc() }
/// Returns the disk number (if present) from music info tag as integer.
///
/// @return [integer] Disc number
///
///
///-----------------------------------------------------------------------
///
///
getDisc();
#else
/**
* getDisc() -- returns an integer.\n
*/
int getDisc();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getReleaseDate() }
/// Returns the release date as string from music info tag (if present).
///
/// @return [string] Release date
///
///
///-----------------------------------------------------------------------
///
///
getReleaseDate();
#else
String getReleaseDate();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getListeners() }
/// Returns the listeners as integer from music info tag.
///
/// @return [integer] Listeners
///
///
///-----------------------------------------------------------------------
///
///
getListeners();
#else
int getListeners();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getPlayCount() }
/// Returns the number of carried out playbacks.
///
/// @return [integer] Playback count
///
///
///-----------------------------------------------------------------------
///
///
getPlayCount();
#else
int getPlayCount();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getLastPlayed() }
/// Returns last played time as string from music info tag.
///
/// @return [string] Last played date / time on tag
///
///
///-----------------------------------------------------------------------
/// @python_v20 Deprecated. Use **getLastPlayedAsW3C()** instead.
///
getLastPlayed();
#else
String getLastPlayed();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getLastPlayedAsW3C() }
/// Returns last played time as string in W3C format (YYYY-MM-DDThh:mm:ssTZD).
///
/// @return [string] Last played datetime (W3C)
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
getLastPlayedAsW3C();
#else
String getLastPlayedAsW3C();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getComment() }
/// Returns comment as string from music info tag.
///
/// @return [string] Comment on tag
///
///
///-----------------------------------------------------------------------
///
///
getComment();
#else
String getComment();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getLyrics() }
/// Returns a string from lyrics.
///
/// @return [string] Lyrics on tag
///
///
///-----------------------------------------------------------------------
///
///
getLyrics();
#else
String getLyrics();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMusicBrainzTrackID() }
/// Returns the MusicBrainz Recording ID from music info tag (if present).
///
/// @return [string] MusicBrainz Recording ID
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getMusicBrainzTrackID();
#else
String getMusicBrainzTrackID();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMusicBrainzArtistID() }
/// Returns the MusicBrainz Artist IDs from music info tag (if present).
///
/// @return [list] MusicBrainz Artist IDs
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getMusicBrainzArtistID();
#else
std::vector<String> getMusicBrainzArtistID();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMusicBrainzAlbumID() }
/// Returns the MusicBrainz Release ID from music info tag (if present).
///
/// @return [string] MusicBrainz Release ID
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getMusicBrainzAlbumID();
#else
String getMusicBrainzAlbumID();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMusicBrainzReleaseGroupID() }
/// Returns the MusicBrainz Release Group ID from music info tag (if present).
///
/// @return [string] MusicBrainz Release Group ID
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getMusicBrainzReleaseGroupID();
#else
String getMusicBrainzReleaseGroupID();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ getMusicBrainzAlbumArtistID() }
/// Returns the MusicBrainz Release Artist IDs from music info tag (if present).
///
/// @return [list] MusicBrainz Release Artist IDs
///
///
///-----------------------------------------------------------------------
/// @python_v19 New function added.
///
getMusicBrainzAlbumArtistID();
#else
std::vector<String> getMusicBrainzAlbumArtistID();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setDbId(dbId, type) }
/// Set the database identifier of the music item.
///
/// @param dbId integer - Database identifier.
/// @param type string - Media type of the item.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDbId(...);
#else
void setDbId(int dbId, const String& type);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setURL(url) }
/// Set the URL of the music item.
///
/// @param url string - URL.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setURL(...);
#else
void setURL(const String& url);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMediaType(mediaType) }
/// Set the media type of the music item.
///
/// @param mediaType string - Media type.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMediaType(...);
#else
void setMediaType(const String& mediaType);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setTrack(track) }
/// Set the track number of the song.
///
/// @param track integer - Track number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTrack(...);
#else
void setTrack(int track);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setDisc(disc) }
/// Set the disc number of the song.
///
/// @param disc integer - Disc number.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDisc(...);
#else
void setDisc(int disc);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setDuration(duration) }
/// Set the duration of the song.
///
/// @param duration integer - Duration in seconds.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setDuration(...);
#else
void setDuration(int duration);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setYear(year) }
/// Set the year of the music item.
///
/// @param year integer - Year.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setYear(...);
#else
void setYear(int year);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setReleaseDate(releaseDate) }
/// Set the release date of the music item.
///
/// @param releaseDate string - Release date in ISO8601 format (YYYY, YYYY-MM or YYYY-MM-DD).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setReleaseDate(...);
#else
void setReleaseDate(const String& releaseDate);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setListeners(listeners) }
/// Set the number of listeners of the music item.
///
/// @param listeners integer - Number of listeners.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setListeners(...);
#else
void setListeners(int listeners);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setPlayCount(playcount) }
/// Set the playcount of the music item.
///
/// @param playcount integer - Playcount.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setPlayCount(...);
#else
void setPlayCount(int playcount);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setGenres(genres) }
/// Set the genres of the music item.
///
/// @param genres list - Genres.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setGenres(...);
#else
void setGenres(const std::vector<String>& genres);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setAlbum(album) }
/// Set the album of the music item.
///
/// @param album string - Album.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setAlbum(...);
#else
void setAlbum(const String& album);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setArtist(artist) }
/// Set the artist(s) of the music item.
///
/// @param artist string - Artist(s).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setArtist(...);
#else
void setArtist(const String& artist);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setAlbumArtist(albumArtist) }
/// Set the album artist(s) of the music item.
///
/// @param albumArtist string - Album artist(s).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setAlbumArtist(...);
#else
void setAlbumArtist(const String& albumArtist);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setTitle(title) }
/// Set the title of the music item.
///
/// @param title string - Title.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setTitle(...);
#else
void setTitle(const String& title);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setRating(rating) }
/// Set the rating of the music item.
///
/// @param rating float - Rating.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setRating(...);
#else
void setRating(float rating);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setUserRating(userrating) }
/// Set the user rating of the music item.
///
/// @param userrating integer - User rating.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setUserRating(...);
#else
void setUserRating(int userrating);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setLyrics(lyrics) }
/// Set the lyrics of the song.
///
/// @param lyrics string - Lyrics.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLyrics(...);
#else
void setLyrics(const String& lyrics);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setLastPlayed(lastPlayed) }
/// Set the last played date of the music item.
///
/// @param lastPlayed string - Last played date (YYYY-MM-DD HH:MM:SS).
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setLastPlayed(...);
#else
void setLastPlayed(const String& lastPlayed);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMusicBrainzTrackID(musicBrainzTrackID) }
/// Set the MusicBrainz track ID of the song.
///
/// @param musicBrainzTrackID string - MusicBrainz track ID.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMusicBrainzTrackID(...);
#else
void setMusicBrainzTrackID(const String& musicBrainzTrackID);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMusicBrainzArtistID(musicBrainzArtistID) }
/// Set the MusicBrainz artist IDs of the music item.
///
/// @param musicBrainzArtistID list - MusicBrainz artist IDs.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMusicBrainzArtistID(...);
#else
void setMusicBrainzArtistID(const std::vector<String>& musicBrainzArtistID);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMusicBrainzAlbumID(musicBrainzAlbumID) }
/// Set the MusicBrainz album ID of the music item.
///
/// @param musicBrainzAlbumID string - MusicBrainz album ID.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMusicBrainzAlbumID(...);
#else
void setMusicBrainzAlbumID(const String& musicBrainzAlbumID);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMusicBrainzReleaseGroupID(musicBrainzReleaseGroupID) }
/// Set the MusicBrainz release group ID of the music item.
///
/// @param musicBrainzReleaseGroupID string - MusicBrainz release group ID.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMusicBrainzReleaseGroupID(...);
#else
void setMusicBrainzReleaseGroupID(const String& musicBrainzReleaseGroupID);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setMusicBrainzAlbumArtistID(musicBrainzAlbumArtistID) }
/// Set the MusicBrainz album artist IDs of the music item.
///
/// @param musicBrainzAlbumArtistID list - MusicBrainz album artist IDs.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setMusicBrainzAlbumArtistID(...);
#else
void setMusicBrainzAlbumArtistID(const std::vector<String>& musicBrainzAlbumArtistID);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_InfoTagMusic
/// @brief \python_func{ setComment(comment) }
/// Set the comment of the music item.
///
/// @param comment string - Comment.
///
///
///-----------------------------------------------------------------------
/// @python_v20 New function added.
///
setComment(...);
#else
void setComment(const String& comment);
#endif
#ifndef SWIG
static void setDbIdRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int dbId, const String& type);
static void setURLRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& url);
static void setMediaTypeRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& mediaType);
static void setTrackRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int track);
static void setDiscRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int disc);
static void setDurationRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int duration);
static void setYearRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int year);
static void setReleaseDateRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& releaseDate);
static void setListenersRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int listeners);
static void setPlayCountRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int playcount);
static void setGenresRaw(MUSIC_INFO::CMusicInfoTag* infoTag,
const std::vector<String>& genres);
static void setAlbumRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& album);
static void setArtistRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& artist);
static void setAlbumArtistRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& albumArtist);
static void setTitleRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& title);
static void setRatingRaw(MUSIC_INFO::CMusicInfoTag* infoTag, float rating);
static void setUserRatingRaw(MUSIC_INFO::CMusicInfoTag* infoTag, int userrating);
static void setLyricsRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& lyrics);
static void setLastPlayedRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& lastPlayed);
static void setMusicBrainzTrackIDRaw(MUSIC_INFO::CMusicInfoTag* infoTag,
const String& musicBrainzTrackID);
static void setMusicBrainzArtistIDRaw(MUSIC_INFO::CMusicInfoTag* infoTag,
const std::vector<String>& musicBrainzArtistID);
static void setMusicBrainzAlbumIDRaw(MUSIC_INFO::CMusicInfoTag* infoTag,
const String& musicBrainzAlbumID);
static void setMusicBrainzReleaseGroupIDRaw(MUSIC_INFO::CMusicInfoTag* infoTag,
const String& musicBrainzReleaseGroupID);
static void setMusicBrainzAlbumArtistIDRaw(
MUSIC_INFO::CMusicInfoTag* infoTag, const std::vector<String>& musicBrainzAlbumArtistID);
static void setCommentRaw(MUSIC_INFO::CMusicInfoTag* infoTag, const String& comment);
#endif
};
//@}
}
}
|