Kodi Development 22.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches

Detailed Description

Info tag data structure
Representation of available information of processed audio file.

This is used to store all the necessary data of audio stream and to have on e.g. GUI for information.

Called from kodi::addon::CInstanceVisualization::UpdateTrack() with the information of the currently-playing song.


The following table contains values that can be set with class VisualizationTrack :

Name Type Set call Get call
Title of the current song. std::string SetTitle GetTitle
Artist names, as a single string std::string SetArtist GetArtist
Album that the current song is from. std::string SetAlbum GetAlbum
Album artist names, as a single string std::string SetAlbumArtist GetAlbumArtist
The genre name from the music tag, if present std::string SetGenre GetGenre
Duration of the current song, in seconds int SetDuration GetDuration
Track number of the current song int SetTrack GetTrack
Disc number of the current song stored in the ID tag info int SetDisc GetDisc
Year that the current song was released int SetYear GetYear
Lyrics of the current song, if available std::string SetLyrics GetLyrics
The user-defined rating of the current song int SetRating GetRating
Comment of the current song stored in the ID tag info std::string SetComment GetComment

Topics

 Value Help
 

Function Documentation

◆ SetTitle()

void SetTitle ( const std::string & title)
inline

Set title of the current song.

◆ GetTitle()

const std::string & GetTitle ( ) const
inline

Get title of the current song.

◆ SetArtist()

void SetArtist ( const std::string & artist)
inline

Set artist names, as a single string-.

◆ GetArtist()

const std::string & GetArtist ( ) const
inline

Get artist names, as a single string-.

◆ SetAlbum()

void SetAlbum ( const std::string & album)
inline

Set Album that the current song is from.

◆ GetAlbum()

const std::string & GetAlbum ( ) const
inline

Get Album that the current song is from.

◆ SetAlbumArtist()

void SetAlbumArtist ( const std::string & albumArtist)
inline

Set album artist names, as a single stringalbum artist name.

◆ GetAlbumArtist()

const std::string & GetAlbumArtist ( ) const
inline

Get album artist names, as a single string-.

◆ SetGenre()

void SetGenre ( const std::string & genre)
inline

Set genre name from music as string if present.

◆ GetGenre()

const std::string & GetGenre ( ) const
inline

Get genre name from music as string if present.

◆ SetDuration()

void SetDuration ( int duration)
inline

Set the duration of music as integer from info.

◆ GetDuration()

int GetDuration ( ) const
inline

Get the duration of music as integer from info.

◆ SetTrack()

void SetTrack ( int trackNumber)
inline

Set track number (if present) from music info as integer.

◆ GetTrack()

int GetTrack ( ) const
inline

Get track number (if present).

◆ SetDisc()

void SetDisc ( int discNumber)
inline

Set disk number (if present) from music info as integer.

◆ GetDisc()

int GetDisc ( ) const
inline

Get disk number (if present)

◆ SetYear()

void SetYear ( int year)
inline

Set year that the current song was released.

◆ GetYear()

int GetYear ( ) const
inline

Get year that the current song was released.

◆ SetLyrics()

void SetLyrics ( const std::string & lyrics)
inline

Set string from lyrics.

◆ GetLyrics()

const std::string & GetLyrics ( ) const
inline

Get string from lyrics.

◆ SetRating()

void SetRating ( int rating)
inline

Set the user-defined rating of the current song.

◆ GetRating()

int GetRating ( ) const
inline

Get the user-defined rating of the current song.

◆ SetComment()

void SetComment ( const std::string & comment)
inline

Set additional information comment (if present).

◆ GetComment()

const std::string & GetComment ( ) const
inline

Get additional information comment (if present).