Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <MusicInfoTag.h>
Public Member Functions | |
CMusicInfoTag (void) | |
bool | operator!= (const CMusicInfoTag &tag) const |
bool | Loaded () const |
const std::string & | GetTitle () const |
const std::string & | GetURL () const |
const std::vector< std::string > & | GetArtist () const |
const std::string & | GetArtistSort () const |
const std::string | GetArtistString () const |
const std::string & | GetComposerSort () const |
const std::string & | GetAlbum () const |
int | GetAlbumId () const |
const std::vector< std::string > & | GetAlbumArtist () const |
const std::string | GetAlbumArtistString () const |
const std::string & | GetAlbumArtistSort () const |
const std::vector< std::string > & | GetGenre () const |
int | GetTrackNumber () const |
int | GetDiscNumber () const |
int | GetTrackAndDiscNumber () const |
int | GetTotalDiscs () const |
int | GetDuration () const |
int | GetYear () const |
const std::string & | GetReleaseDate () const |
const std::string | GetReleaseYear () const |
const std::string & | GetOriginalDate () const |
const std::string | GetOriginalYear () const |
int | GetDatabaseId () const |
const std::string & | GetType () const |
const std::string & | GetDiscSubtitle () const |
int | GetBPM () const |
std::string | GetYearString () const |
const std::string & | GetMusicBrainzTrackID () const |
const std::vector< std::string > & | GetMusicBrainzArtistID () const |
const std::vector< std::string > & | GetMusicBrainzArtistHints () const |
const std::string & | GetMusicBrainzAlbumID () const |
const std::string & | GetMusicBrainzReleaseGroupID () const |
const std::vector< std::string > & | GetMusicBrainzAlbumArtistID () const |
const std::vector< std::string > & | GetMusicBrainzAlbumArtistHints () const |
const std::string & | GetMusicBrainzReleaseType () const |
const std::string & | GetComment () const |
const std::string & | GetMood () const |
const std::string & | GetRecordLabel () const |
const std::string & | GetLyrics () const |
const std::string & | GetCueSheet () const |
const CDateTime & | GetLastPlayed () const |
const CDateTime & | GetDateAdded () const |
bool | GetCompilation () const |
bool | GetBoxset () const |
float | GetRating () const |
int | GetUserrating () const |
int | GetVotes () const |
int | GetListeners () const |
int | GetPlayCount () const |
int | GetBitRate () const |
int | GetNoOfChannels () const |
int | GetSampleRate () const |
const std::string & | GetAlbumReleaseStatus () const |
const std::string & | GetStationName () const |
const std::string & | GetStationArt () const |
const std::string & | GetSongVideoURL () const |
const EmbeddedArtInfo & | GetCoverArtInfo () const |
const ReplayGain & | GetReplayGain () const |
CAlbum::ReleaseType | GetAlbumReleaseType () const |
void | SetURL (const std::string &strURL) |
void | SetTitle (const std::string &strTitle) |
void | SetArtist (const std::string &strArtist) |
void | SetArtist (const std::vector< std::string > &artists, bool FillDesc=false) |
void | SetArtistDesc (const std::string &strArtistDesc) |
void | SetArtistSort (const std::string &strArtistsort) |
void | SetComposerSort (const std::string &strComposerSort) |
void | SetAlbum (const std::string &strAlbum) |
void | SetAlbumId (const int iAlbumId) |
void | SetAlbumArtist (const std::string &strAlbumArtist) |
void | SetAlbumArtist (const std::vector< std::string > &albumArtists, bool FillDesc=false) |
void | SetAlbumArtistDesc (const std::string &strAlbumArtistDesc) |
void | SetAlbumArtistSort (const std::string &strAlbumArtistSort) |
void | SetGenre (const std::string &strGenre, bool bTrim=false) |
void | SetGenre (const std::vector< std::string > &genres, bool bTrim=false) |
void | SetYear (int year) |
void | SetOriginalDate (const std::string &strOriginalDate) |
void | SetReleaseDate (const std::string &strReleaseDate) |
void | SetDatabaseId (int id, const std::string &type) |
void | SetTrackNumber (int iTrack) |
void | SetDiscNumber (int iDiscNumber) |
void | SetTrackAndDiscNumber (int iTrackAndDisc) |
void | SetDuration (int iSec) |
void | SetLoaded (bool bOnOff=true) |
void | SetArtist (const CArtist &artist) |
void | SetAlbum (const CAlbum &album) |
void | SetSong (const CSong &song) |
void | SetMusicBrainzTrackID (const std::string &strTrackID) |
void | SetMusicBrainzArtistID (const std::vector< std::string > &musicBrainzArtistId) |
void | SetMusicBrainzArtistHints (const std::vector< std::string > &musicBrainzArtistHints) |
void | SetMusicBrainzAlbumID (const std::string &strAlbumID) |
void | SetMusicBrainzAlbumArtistID (const std::vector< std::string > &musicBrainzAlbumArtistId) |
void | SetMusicBrainzAlbumArtistHints (const std::vector< std::string > &musicBrainzAlbumArtistHints) |
void | SetMusicBrainzReleaseGroupID (const std::string &strReleaseGroupID) |
void | SetMusicBrainzReleaseType (const std::string &ReleaseType) |
void | SetComment (const std::string &comment) |
void | SetMood (const std::string &mood) |
void | SetRecordLabel (const std::string &publisher) |
void | SetLyrics (const std::string &lyrics) |
void | SetCueSheet (const std::string &cueSheet) |
void | SetRating (float rating) |
void | SetUserrating (int rating) |
void | SetVotes (int votes) |
void | SetListeners (int listeners) |
void | SetPlayCount (int playcount) |
void | SetLastPlayed (const std::string &strLastPlayed) |
void | SetLastPlayed (const CDateTime &strLastPlayed) |
void | SetDateAdded (const std::string &strDateAdded) |
void | SetDateAdded (const CDateTime &dateAdded) |
void | SetDateUpdated (const std::string &strDateUpdated) |
void | SetDateUpdated (const CDateTime &dateUpdated) |
void | SetDateNew (const std::string &strDateNew) |
void | SetDateNew (const CDateTime &dateNew) |
void | SetCompilation (bool compilation) |
void | SetBoxset (bool boxset) |
void | SetCoverArtInfo (size_t size, const std::string &mimeType) |
void | SetReplayGain (const ReplayGain &aGain) |
void | SetAlbumReleaseType (CAlbum::ReleaseType releaseType) |
void | SetType (const MediaType &mediaType) |
void | SetDiscSubtitle (const std::string &strDiscSubtitle) |
void | SetTotalDiscs (int iDiscTotal) |
void | SetBPM (int iBPM) |
void | SetBitRate (int bitrate) |
void | SetNoOfChannels (int channels) |
void | SetSampleRate (int samplerate) |
void | SetAlbumReleaseStatus (const std::string &strReleaseStatus) |
void | SetStationName (const std::string &strStationName) |
void | SetStationArt (const std::string &strStationArt) |
void | SetSongVideoURL (const std::string &songVideoURL) |
void | AppendArtist (const std::string &artist) |
Append a unique artist to the artist list Checks if we have this artist already added, and if not adds it to the songs artist list. | |
void | AppendAlbumArtist (const std::string &albumArtist) |
Append a unique album artist to the artist list Checks if we have this album artist already added, and if not adds it to the songs album artist list. | |
void | AppendGenre (const std::string &genre) |
Append a unique genre to the genre list Checks if we have this genre already added, and if not adds it to the songs genre list. | |
void | AddOriginalDate (const std::string &strDateYear) |
void | AddReleaseDate (const std::string &strDateYear, bool isMonth=false) |
void | AddArtistRole (const std::string &Role, const std::string &strArtist) |
void | AddArtistRole (const std::string &Role, const std::vector< std::string > &artists) |
void | AppendArtistRole (const CMusicRole &ArtistRole) |
const std::string | GetArtistStringForRole (const std::string &strRole) const |
const std::string | GetContributorsText () const |
const std::string | GetContributorsAndRolesText () const |
const VECMUSICROLES & | GetContributors () const |
void | SetContributors (const VECMUSICROLES &contributors) |
bool | HasContributors () const |
void | Archive (CArchive &ar) override |
void | Serialize (CVariant &ar) const override |
void | ToSortable (SortItem &sortable, Field field) const override |
void | Clear () |
Protected Member Functions | |
std::string | Trim (const std::string &value) const |
Trim whitespace off the given string. | |
Protected Member Functions inherited from IArchivable | |
virtual | ~IArchivable ()=default |
Protected Member Functions inherited from ISerializable | |
~ISerializable ()=default | |
Protected Member Functions inherited from ISortable | |
~ISortable ()=default | |
CMusicInfoTag::CMusicInfoTag | ( | void | ) |
void CMusicInfoTag::AddArtistRole | ( | const std::string & | Role, |
const std::string & | strArtist ) |
void CMusicInfoTag::AddArtistRole | ( | const std::string & | Role, |
const std::vector< std::string > & | artists ) |
void CMusicInfoTag::AddOriginalDate | ( | const std::string & | strDateYear | ) |
void CMusicInfoTag::AppendAlbumArtist | ( | const std::string & | albumArtist | ) |
Append a unique album artist to the artist list Checks if we have this album artist already added, and if not adds it to the songs album artist list.
albumArtist | album artist to add. |
void CMusicInfoTag::AppendArtist | ( | const std::string & | artist | ) |
Append a unique artist to the artist list Checks if we have this artist already added, and if not adds it to the songs artist list.
value | artist to add. |
void CMusicInfoTag::AppendArtistRole | ( | const CMusicRole & | ArtistRole | ) |
void CMusicInfoTag::AppendGenre | ( | const std::string & | genre | ) |
Append a unique genre to the genre list Checks if we have this genre already added, and if not adds it to the songs genre list.
genre | genre to add. |
Implements IArchivable.
void CMusicInfoTag::Clear | ( | ) |
const std::string & CMusicInfoTag::GetAlbum | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetAlbumArtist | ( | ) | const |
const std::string & CMusicInfoTag::GetAlbumArtistSort | ( | ) | const |
const std::string CMusicInfoTag::GetAlbumArtistString | ( | ) | const |
int CMusicInfoTag::GetAlbumId | ( | ) | const |
const std::string & CMusicInfoTag::GetAlbumReleaseStatus | ( | ) | const |
CAlbum::ReleaseType CMusicInfoTag::GetAlbumReleaseType | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetArtist | ( | ) | const |
const std::string & CMusicInfoTag::GetArtistSort | ( | ) | const |
const std::string CMusicInfoTag::GetArtistString | ( | ) | const |
const std::string CMusicInfoTag::GetArtistStringForRole | ( | const std::string & | strRole | ) | const |
int CMusicInfoTag::GetBitRate | ( | ) | const |
bool CMusicInfoTag::GetBoxset | ( | ) | const |
int CMusicInfoTag::GetBPM | ( | ) | const |
const std::string & CMusicInfoTag::GetComment | ( | ) | const |
bool CMusicInfoTag::GetCompilation | ( | ) | const |
const std::string & CMusicInfoTag::GetComposerSort | ( | ) | const |
const VECMUSICROLES & CMusicInfoTag::GetContributors | ( | ) | const |
const std::string CMusicInfoTag::GetContributorsAndRolesText | ( | ) | const |
const std::string CMusicInfoTag::GetContributorsText | ( | ) | const |
const EmbeddedArtInfo & CMusicInfoTag::GetCoverArtInfo | ( | ) | const |
const std::string & CMusicInfoTag::GetCueSheet | ( | ) | const |
int CMusicInfoTag::GetDatabaseId | ( | ) | const |
const CDateTime & CMusicInfoTag::GetDateAdded | ( | ) | const |
int CMusicInfoTag::GetDiscNumber | ( | ) | const |
const std::string & CMusicInfoTag::GetDiscSubtitle | ( | ) | const |
int CMusicInfoTag::GetDuration | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetGenre | ( | ) | const |
const CDateTime & CMusicInfoTag::GetLastPlayed | ( | ) | const |
int CMusicInfoTag::GetListeners | ( | ) | const |
const std::string & CMusicInfoTag::GetLyrics | ( | ) | const |
const std::string & CMusicInfoTag::GetMood | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetMusicBrainzAlbumArtistHints | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetMusicBrainzAlbumArtistID | ( | ) | const |
const std::string & CMusicInfoTag::GetMusicBrainzAlbumID | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetMusicBrainzArtistHints | ( | ) | const |
const std::vector< std::string > & CMusicInfoTag::GetMusicBrainzArtistID | ( | ) | const |
const std::string & MUSIC_INFO::CMusicInfoTag::GetMusicBrainzReleaseGroupID | ( | ) | const |
const std::string & CMusicInfoTag::GetMusicBrainzReleaseType | ( | ) | const |
const std::string & CMusicInfoTag::GetMusicBrainzTrackID | ( | ) | const |
int CMusicInfoTag::GetNoOfChannels | ( | ) | const |
const std::string & CMusicInfoTag::GetOriginalDate | ( | ) | const |
const std::string MUSIC_INFO::CMusicInfoTag::GetOriginalYear | ( | ) | const |
int CMusicInfoTag::GetPlayCount | ( | ) | const |
float CMusicInfoTag::GetRating | ( | ) | const |
const std::string & CMusicInfoTag::GetRecordLabel | ( | ) | const |
const std::string & CMusicInfoTag::GetReleaseDate | ( | ) | const |
const std::string MUSIC_INFO::CMusicInfoTag::GetReleaseYear | ( | ) | const |
const ReplayGain & CMusicInfoTag::GetReplayGain | ( | ) | const |
int CMusicInfoTag::GetSampleRate | ( | ) | const |
const std::string & CMusicInfoTag::GetSongVideoURL | ( | ) | const |
const std::string & CMusicInfoTag::GetStationArt | ( | ) | const |
const std::string & CMusicInfoTag::GetStationName | ( | ) | const |
const std::string & CMusicInfoTag::GetTitle | ( | ) | const |
int CMusicInfoTag::GetTotalDiscs | ( | ) | const |
int CMusicInfoTag::GetTrackAndDiscNumber | ( | ) | const |
int CMusicInfoTag::GetTrackNumber | ( | ) | const |
const std::string & CMusicInfoTag::GetType | ( | ) | const |
const std::string & CMusicInfoTag::GetURL | ( | ) | const |
int CMusicInfoTag::GetUserrating | ( | ) | const |
int CMusicInfoTag::GetVotes | ( | ) | const |
int CMusicInfoTag::GetYear | ( | ) | const |
std::string CMusicInfoTag::GetYearString | ( | ) | const |
|
inline |
bool CMusicInfoTag::Loaded | ( | ) | const |
bool CMusicInfoTag::operator!= | ( | const CMusicInfoTag & | tag | ) | const |
Implements ISerializable.
void CMusicInfoTag::SetAlbum | ( | const std::string & | strAlbum | ) |
void CMusicInfoTag::SetAlbumArtist | ( | const std::string & | strAlbumArtist | ) |
void CMusicInfoTag::SetAlbumArtist | ( | const std::vector< std::string > & | albumArtists, |
bool | FillDesc = false ) |
void CMusicInfoTag::SetAlbumArtistDesc | ( | const std::string & | strAlbumArtistDesc | ) |
void CMusicInfoTag::SetAlbumArtistSort | ( | const std::string & | strAlbumArtistSort | ) |
void CMusicInfoTag::SetAlbumReleaseStatus | ( | const std::string & | strReleaseStatus | ) |
void CMusicInfoTag::SetAlbumReleaseType | ( | CAlbum::ReleaseType | releaseType | ) |
void CMusicInfoTag::SetArtist | ( | const std::string & | strArtist | ) |
void CMusicInfoTag::SetArtistDesc | ( | const std::string & | strArtistDesc | ) |
void CMusicInfoTag::SetArtistSort | ( | const std::string & | strArtistsort | ) |
void CMusicInfoTag::SetComment | ( | const std::string & | comment | ) |
void CMusicInfoTag::SetComposerSort | ( | const std::string & | strComposerSort | ) |
void CMusicInfoTag::SetContributors | ( | const VECMUSICROLES & | contributors | ) |
void CMusicInfoTag::SetCoverArtInfo | ( | size_t | size, |
const std::string & | mimeType ) |
void CMusicInfoTag::SetCueSheet | ( | const std::string & | cueSheet | ) |
void CMusicInfoTag::SetDateAdded | ( | const std::string & | strDateAdded | ) |
void MUSIC_INFO::CMusicInfoTag::SetDateNew | ( | const std::string & | strDateNew | ) |
void MUSIC_INFO::CMusicInfoTag::SetDateUpdated | ( | const std::string & | strDateUpdated | ) |
void CMusicInfoTag::SetDiscSubtitle | ( | const std::string & | strDiscSubtitle | ) |
void CMusicInfoTag::SetLastPlayed | ( | const std::string & | strLastPlayed | ) |
void CMusicInfoTag::SetLyrics | ( | const std::string & | lyrics | ) |
void CMusicInfoTag::SetMood | ( | const std::string & | mood | ) |
void CMusicInfoTag::SetMusicBrainzAlbumArtistHints | ( | const std::vector< std::string > & | musicBrainzAlbumArtistHints | ) |
void CMusicInfoTag::SetMusicBrainzAlbumArtistID | ( | const std::vector< std::string > & | musicBrainzAlbumArtistId | ) |
void CMusicInfoTag::SetMusicBrainzAlbumID | ( | const std::string & | strAlbumID | ) |
void CMusicInfoTag::SetMusicBrainzArtistHints | ( | const std::vector< std::string > & | musicBrainzArtistHints | ) |
void CMusicInfoTag::SetMusicBrainzArtistID | ( | const std::vector< std::string > & | musicBrainzArtistId | ) |
void MUSIC_INFO::CMusicInfoTag::SetMusicBrainzReleaseGroupID | ( | const std::string & | strReleaseGroupID | ) |
void CMusicInfoTag::SetMusicBrainzReleaseType | ( | const std::string & | ReleaseType | ) |
void CMusicInfoTag::SetMusicBrainzTrackID | ( | const std::string & | strTrackID | ) |
void CMusicInfoTag::SetOriginalDate | ( | const std::string & | strOriginalDate | ) |
void CMusicInfoTag::SetRating | ( | float | rating | ) |
void CMusicInfoTag::SetRecordLabel | ( | const std::string & | publisher | ) |
void CMusicInfoTag::SetReleaseDate | ( | const std::string & | strReleaseDate | ) |
void CMusicInfoTag::SetReplayGain | ( | const ReplayGain & | aGain | ) |
void CMusicInfoTag::SetSongVideoURL | ( | const std::string & | songVideoURL | ) |
void CMusicInfoTag::SetStationArt | ( | const std::string & | strStationArt | ) |
void CMusicInfoTag::SetStationName | ( | const std::string & | strStationName | ) |
void CMusicInfoTag::SetTitle | ( | const std::string & | strTitle | ) |
void CMusicInfoTag::SetURL | ( | const std::string & | strURL | ) |
Implements ISortable.
|
protected |
Trim whitespace off the given string.
value | string to trim |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
art information
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
ReplayGain information.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
item type "music", "song", "album", "artist"
|
protected |
|
protected |