xbmc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MUSIC_INFO::CMusicInfoTag Class Referencefinal
Inheritance diagram for MUSIC_INFO::CMusicInfoTag:
Inheritance graph
[legend]
Collaboration diagram for MUSIC_INFO::CMusicInfoTag:
Collaboration graph
[legend]

Public Member Functions

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 CDateTimeGetLastPlayed () const
 
const CDateTimeGetDateAdded () 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 EmbeddedArtInfoGetCoverArtInfo () const
 
const ReplayGainGetReplayGain () 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. More...
 
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. More...
 
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. More...
 
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. More...
 

Protected Attributes

std::string m_strURL
 
std::string m_strTitle
 
std::vector< std::string > m_artist
 
std::string m_strArtistSort
 
std::string m_strArtistDesc
 
std::string m_strComposerSort
 
std::string m_strAlbum
 
std::vector< std::string > m_albumArtist
 
std::string m_strAlbumArtistDesc
 
std::string m_strAlbumArtistSort
 
std::vector< std::string > m_genre
 
std::string m_strMusicBrainzTrackID
 
std::vector< std::string > m_musicBrainzArtistID
 
std::vector< std::string > m_musicBrainzArtistHints
 
std::string m_strMusicBrainzAlbumID
 
std::vector< std::string > m_musicBrainzAlbumArtistID
 
std::vector< std::string > m_musicBrainzAlbumArtistHints
 
std::string m_strMusicBrainzReleaseGroupID
 
std::string m_strMusicBrainzReleaseType
 
VECMUSICROLES m_musicRoles
 
std::string m_strComment
 
std::string m_strMood
 
std::string m_strRecordLabel
 
std::string m_strLyrics
 
std::string m_cuesheet
 
std::string m_strDiscSubtitle
 
std::string m_strReleaseDate
 
std::string m_strOriginalDate
 
CDateTime m_lastPlayed
 
CDateTime m_dateNew
 
CDateTime m_dateAdded
 
CDateTime m_dateUpdated
 
bool m_bCompilation
 
int m_iDuration
 
int m_iTrack
 
int m_iDbId
 
MediaType m_type
 item type "music", "song", "album", "artist"
 
bool m_bLoaded
 
float m_Rating
 
int m_Userrating
 
int m_Votes
 
int m_listeners
 
int m_iTimesPlayed
 
int m_iAlbumId
 
int m_iDiscTotal
 
bool m_bBoxset
 
int m_iBPM
 
CAlbum::ReleaseType m_albumReleaseType
 
std::string m_strReleaseStatus
 
int m_samplerate
 
int m_channels
 
int m_bitrate
 
std::string m_stationName
 
std::string m_stationArt
 
std::string m_songVideoURL
 
EmbeddedArtInfo m_coverArt
 art information
 
ReplayGain m_replayGain
 ReplayGain information.
 

Member Function Documentation

◆ AppendAlbumArtist()

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.

Parameters
albumArtistalbum artist to add.

◆ AppendArtist()

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.

Parameters
valueartist to add.

◆ AppendGenre()

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.

Parameters
genregenre to add.

◆ Trim()

std::string CMusicInfoTag::Trim ( const std::string &  value) const
protected

Trim whitespace off the given string.

Parameters
valuestring to trim
Returns
trimmed value, with spaces removed from left and right, as well as carriage returns from the right.

The documentation for this class was generated from the following files: