Kodi Documentation  20.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc::InfoTagMusic Class Reference

#include <InfoTagMusic.h>

Inheritance diagram for XBMCAddon::xbmc::InfoTagMusic:
Collaboration diagram for XBMCAddon::xbmc::InfoTagMusic:

Public Member Functions

 InfoTagMusic (const MUSIC_INFO::CMusicInfoTag *tag)
 
 InfoTagMusic (MUSIC_INFO::CMusicInfoTag *tag, bool offscreen=false)
 
 InfoTagMusic (...)
 

Function: xbmc.InfoTagMusic([offscreen])


Create a music info tag. More...
 
 ~InfoTagMusic () override
 
 getDbId ()
 

Function: getDbId()


Get identification number of tag in database. More...
 
 getURL ()
 

Function: getURL()


Returns url of source as string from music info tag. More...
 
 getTitle ()
 

Function: getTitle()


Returns the title from music as string on info tag. More...
 
 getMediaType ()
 

Function: getMediaType()


Get the media type of the music item. More...
 
 getArtist ()
 

Function: getArtist()


Returns the artist from music as string if present. More...
 
 getAlbum ()
 

Function: getAlbum()


Returns the album from music tag as string if present. More...
 
 getAlbumArtist ()
 

Function: getAlbumArtist()


Returns the album artist from music tag as string if present. More...
 
 getGenre ()
 

Function: getGenre()


Returns the genre name from music tag as string if present. More...
 
 getGenres ()
 

Function: getGenres()


Returns the list of genres from music tag if present. More...
 
 getDuration ()
 

Function: getDuration()


Returns the duration of music as integer from info tag. More...
 
 getYear ()
 

Function: getYear()


Returns the year of music as integer from info tag. More...
 
 getRating ()
 

Function: getRating()


Returns the scraped rating as integer. More...
 
 getUserRating ()
 

Function: getUserRating()


Returns the user rating as integer (-1 if not existing) More...
 
 getTrack ()
 

Function: getTrack()


Returns the track number (if present) from music info tag as integer. More...
 
 getDisc ()
 

Function: getDisc()


Returns the disk number (if present) from music info tag as integer. More...
 
 getReleaseDate ()
 

Function: getReleaseDate()


Returns the release date as string from music info tag (if present). More...
 
 getListeners ()
 

Function: getListeners()


Returns the listeners as integer from music info tag. More...
 
 getPlayCount ()
 

Function: getPlayCount()


Returns the number of carried out playbacks. More...
 
 getLastPlayed ()
 

Function: getLastPlayed()


Returns last played time as string from music info tag. More...
 
 getLastPlayedAsW3C ()
 

Function: getLastPlayedAsW3C()


Returns last played time as string in W3C format (YYYY-MM-DDThh:mm:ssTZD). More...
 
 getComment ()
 

Function: getComment()


Returns comment as string from music info tag. More...
 
 getLyrics ()
 

Function: getLyrics()


Returns a string from lyrics. More...
 
 getMusicBrainzTrackID ()
 

Function: getMusicBrainzTrackID()


Returns the MusicBrainz Recording ID from music info tag (if present). More...
 
 getMusicBrainzArtistID ()
 

Function: getMusicBrainzArtistID()


Returns the MusicBrainz Artist IDs from music info tag (if present). More...
 
 getMusicBrainzAlbumID ()
 

Function: getMusicBrainzAlbumID()


Returns the MusicBrainz Release ID from music info tag (if present). More...
 
 getMusicBrainzReleaseGroupID ()
 

Function: getMusicBrainzReleaseGroupID()


Returns the MusicBrainz Release Group ID from music info tag (if present). More...
 
 getMusicBrainzAlbumArtistID ()
 

Function: getMusicBrainzAlbumArtistID()


Returns the MusicBrainz Release Artist IDs from music info tag (if present). More...
 
 setDbId (...)
 

Function: setDbId(dbId, type)


Set the database identifier of the music item. More...
 
 setURL (...)
 

Function: setURL(url)


Set the URL of the music item. More...
 
 setMediaType (...)
 

Function: setMediaType(mediaType)


Set the media type of the music item. More...
 
 setTrack (...)
 

Function: setTrack(track)


Set the track number of the song. More...
 
 setDisc (...)
 

Function: setDisc(disc)


Set the disc number of the song. More...
 
 setDuration (...)
 

Function: setDuration(duration)


Set the duration of the song. More...
 
 setYear (...)
 

Function: setYear(year)


Set the year of the music item. More...
 
 setReleaseDate (...)
 

Function: setReleaseDate(releaseDate)


Set the release date of the music item. More...
 
 setListeners (...)
 

Function: setListeners(listeners)


Set the number of listeners of the music item. More...
 
 setPlayCount (...)
 

Function: setPlayCount(playcount)


Set the playcount of the music item. More...
 
 setGenres (...)
 

Function: setGenres(genres)


Set the genres of the music item. More...
 
 setAlbum (...)
 

Function: setAlbum(album)


Set the album of the music item. More...
 
 setArtist (...)
 

Function: setArtist(artist)


Set the artist(s) of the music item. More...
 
 setAlbumArtist (...)
 

Function: setAlbumArtist(albumArtist)


Set the album artist(s) of the music item. More...
 
 setTitle (...)
 

Function: setTitle(title)


Set the title of the music item. More...
 
 setRating (...)
 

Function: setRating(rating)


Set the rating of the music item. More...
 
 setUserRating (...)
 

Function: setUserRating(userrating)


Set the user rating of the music item. More...
 
 setLyrics (...)
 

Function: setLyrics(lyrics)


Set the lyrics of the song. More...
 
 setLastPlayed (...)
 

Function: setLastPlayed(lastPlayed)


Set the last played date of the music item. More...
 
 setMusicBrainzTrackID (...)
 

Function: setMusicBrainzTrackID(musicBrainzTrackID)


Set the MusicBrainz track ID of the song. More...
 
 setMusicBrainzArtistID (...)
 

Function: setMusicBrainzArtistID(musicBrainzArtistID)


Set the MusicBrainz artist IDs of the music item. More...
 
 setMusicBrainzAlbumID (...)
 

Function: setMusicBrainzAlbumID(musicBrainzAlbumID)


Set the MusicBrainz album ID of the music item. More...
 
 setMusicBrainzReleaseGroupID (...)
 

Function: setMusicBrainzReleaseGroupID(musicBrainzReleaseGroupID)


Set the MusicBrainz release group ID of the music item. More...
 
 setMusicBrainzAlbumArtistID (...)
 

Function: setMusicBrainzAlbumArtistID(musicBrainzAlbumArtistID)


Set the MusicBrainz album artist IDs of the music item. More...
 
 setComment (...)
 

Function: setComment(comment)


Set the comment of the music item. More...
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Static Public Member Functions

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)
 
- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 

Additional Inherited Members

- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Constructor & Destructor Documentation

◆ InfoTagMusic() [1/2]

XBMCAddon::xbmc::InfoTagMusic::InfoTagMusic ( const MUSIC_INFO::CMusicInfoTag tag)
explicit

◆ InfoTagMusic() [2/2]

XBMCAddon::xbmc::InfoTagMusic::InfoTagMusic ( MUSIC_INFO::CMusicInfoTag tag,
bool  offscreen = false 
)
explicit

◆ ~InfoTagMusic()

XBMCAddon::xbmc::InfoTagMusic::~InfoTagMusic ( )
override

Member Function Documentation

◆ setAlbumArtistRaw()

void XBMCAddon::xbmc::InfoTagMusic::setAlbumArtistRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String albumArtist 
)
static

◆ setAlbumRaw()

void XBMCAddon::xbmc::InfoTagMusic::setAlbumRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String album 
)
static

◆ setArtistRaw()

void XBMCAddon::xbmc::InfoTagMusic::setArtistRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String artist 
)
static

◆ setCommentRaw()

void XBMCAddon::xbmc::InfoTagMusic::setCommentRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String comment 
)
static

◆ setDbIdRaw()

void XBMCAddon::xbmc::InfoTagMusic::setDbIdRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  dbId,
const String type 
)
static

◆ setDiscRaw()

void XBMCAddon::xbmc::InfoTagMusic::setDiscRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  disc 
)
static

◆ setDurationRaw()

void XBMCAddon::xbmc::InfoTagMusic::setDurationRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  duration 
)
static

◆ setGenresRaw()

void XBMCAddon::xbmc::InfoTagMusic::setGenresRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const std::vector< String > &  genres 
)
static

◆ setLastPlayedRaw()

void XBMCAddon::xbmc::InfoTagMusic::setLastPlayedRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String lastPlayed 
)
static

◆ setListenersRaw()

void XBMCAddon::xbmc::InfoTagMusic::setListenersRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  listeners 
)
static

◆ setLyricsRaw()

void XBMCAddon::xbmc::InfoTagMusic::setLyricsRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String lyrics 
)
static

◆ setMediaTypeRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMediaTypeRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String mediaType 
)
static

◆ setMusicBrainzAlbumArtistIDRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMusicBrainzAlbumArtistIDRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const std::vector< String > &  musicBrainzAlbumArtistID 
)
static

◆ setMusicBrainzAlbumIDRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMusicBrainzAlbumIDRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String musicBrainzAlbumID 
)
static

◆ setMusicBrainzArtistIDRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMusicBrainzArtistIDRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const std::vector< String > &  musicBrainzArtistID 
)
static

◆ setMusicBrainzReleaseGroupIDRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMusicBrainzReleaseGroupIDRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String musicBrainzReleaseGroupID 
)
static

◆ setMusicBrainzTrackIDRaw()

void XBMCAddon::xbmc::InfoTagMusic::setMusicBrainzTrackIDRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String musicBrainzTrackID 
)
static

◆ setPlayCountRaw()

void XBMCAddon::xbmc::InfoTagMusic::setPlayCountRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  playcount 
)
static

◆ setRatingRaw()

void XBMCAddon::xbmc::InfoTagMusic::setRatingRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
float  rating 
)
static

◆ setReleaseDateRaw()

void XBMCAddon::xbmc::InfoTagMusic::setReleaseDateRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String releaseDate 
)
static

◆ setTitleRaw()

void XBMCAddon::xbmc::InfoTagMusic::setTitleRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String title 
)
static

◆ setTrackRaw()

void XBMCAddon::xbmc::InfoTagMusic::setTrackRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  track 
)
static

◆ setURLRaw()

void XBMCAddon::xbmc::InfoTagMusic::setURLRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
const String url 
)
static

◆ setUserRatingRaw()

void XBMCAddon::xbmc::InfoTagMusic::setUserRatingRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  userrating 
)
static

◆ setYearRaw()

void XBMCAddon::xbmc::InfoTagMusic::setYearRaw ( MUSIC_INFO::CMusicInfoTag infoTag,
int  year 
)
static

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