class VisualizationTrack

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

Topics
	Value Help

Classes
class	kodi::addon::VisualizationTrack

Functions
void	kodi::addon::VisualizationTrack::SetTitle (const std::string &title)
	Set title of the current song.
const std::string &	kodi::addon::VisualizationTrack::GetTitle () const
	Get title of the current song.
void	kodi::addon::VisualizationTrack::SetArtist (const std::string &artist)
	Set artist names, as a single string-.
const std::string &	kodi::addon::VisualizationTrack::GetArtist () const
	Get artist names, as a single string-.
void	kodi::addon::VisualizationTrack::SetAlbum (const std::string &album)
	Set Album that the current song is from.
const std::string &	kodi::addon::VisualizationTrack::GetAlbum () const
	Get Album that the current song is from.
void	kodi::addon::VisualizationTrack::SetAlbumArtist (const std::string &albumArtist)
	Set album artist names, as a single stringalbum artist name.
const std::string &	kodi::addon::VisualizationTrack::GetAlbumArtist () const
	Get album artist names, as a single string-.
void	kodi::addon::VisualizationTrack::SetGenre (const std::string &genre)
	Set genre name from music as string if present.
const std::string &	kodi::addon::VisualizationTrack::GetGenre () const
	Get genre name from music as string if present.
void	kodi::addon::VisualizationTrack::SetDuration (int duration)
	Set the duration of music as integer from info.
int	kodi::addon::VisualizationTrack::GetDuration () const
	Get the duration of music as integer from info.
void	kodi::addon::VisualizationTrack::SetTrack (int trackNumber)
	Set track number (if present) from music info as integer.
int	kodi::addon::VisualizationTrack::GetTrack () const
	Get track number (if present).
void	kodi::addon::VisualizationTrack::SetDisc (int discNumber)
	Set disk number (if present) from music info as integer.
int	kodi::addon::VisualizationTrack::GetDisc () const
	Get disk number (if present)
void	kodi::addon::VisualizationTrack::SetYear (int year)
	Set year that the current song was released.
int	kodi::addon::VisualizationTrack::GetYear () const
	Get year that the current song was released.
void	kodi::addon::VisualizationTrack::SetLyrics (const std::string &lyrics)
	Set string from lyrics.
const std::string &	kodi::addon::VisualizationTrack::GetLyrics () const
	Get string from lyrics.
void	kodi::addon::VisualizationTrack::SetRating (int rating)
	Set the user-defined rating of the current song.
int	kodi::addon::VisualizationTrack::GetRating () const
	Get the user-defined rating of the current song.
void	kodi::addon::VisualizationTrack::SetComment (const std::string &comment)
	Set additional information comment (if present).
const std::string &	kodi::addon::VisualizationTrack::GetComment () const
	Get additional information comment (if present).

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

Function Documentation

GetAlbum()

const std::string & kodi::addon::VisualizationTrack::GetAlbum ( ) const

inline

Get Album that the current song is from.

GetAlbumArtist()

const std::string & kodi::addon::VisualizationTrack::GetAlbumArtist ( ) const

inline

Get album artist names, as a single string-.

GetArtist()

const std::string & kodi::addon::VisualizationTrack::GetArtist ( ) const

inline

Get artist names, as a single string-.

GetComment()

const std::string & kodi::addon::VisualizationTrack::GetComment ( ) const

inline

Get additional information comment (if present).

GetDisc()

int kodi::addon::VisualizationTrack::GetDisc ( ) const

inline

Get disk number (if present)

GetDuration()

int kodi::addon::VisualizationTrack::GetDuration ( ) const

inline

Get the duration of music as integer from info.

GetGenre()

const std::string & kodi::addon::VisualizationTrack::GetGenre ( ) const

inline

Get genre name from music as string if present.

GetLyrics()

const std::string & kodi::addon::VisualizationTrack::GetLyrics ( ) const

inline

Get string from lyrics.

GetRating()

int kodi::addon::VisualizationTrack::GetRating ( ) const

inline

Get the user-defined rating of the current song.

GetTitle()

const std::string & kodi::addon::VisualizationTrack::GetTitle ( ) const

inline

Get title of the current song.

GetTrack()

int kodi::addon::VisualizationTrack::GetTrack ( ) const

inline

Get track number (if present).

GetYear()

int kodi::addon::VisualizationTrack::GetYear ( ) const

inline

Get year that the current song was released.

SetAlbum()

void kodi::addon::VisualizationTrack::SetAlbum ( const std::string & album )

inline

Set Album that the current song is from.

SetAlbumArtist()

void kodi::addon::VisualizationTrack::SetAlbumArtist ( const std::string & albumArtist )

inline

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

SetArtist()

void kodi::addon::VisualizationTrack::SetArtist ( const std::string & artist )

inline

Set artist names, as a single string-.

SetComment()

void kodi::addon::VisualizationTrack::SetComment ( const std::string & comment )

inline

Set additional information comment (if present).

SetDisc()

void kodi::addon::VisualizationTrack::SetDisc ( int discNumber )

inline

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

SetDuration()

void kodi::addon::VisualizationTrack::SetDuration ( int duration )

inline

Set the duration of music as integer from info.

SetGenre()

void kodi::addon::VisualizationTrack::SetGenre ( const std::string & genre )

inline

Set genre name from music as string if present.

SetLyrics()

void kodi::addon::VisualizationTrack::SetLyrics ( const std::string & lyrics )

inline

Set string from lyrics.

SetRating()

void kodi::addon::VisualizationTrack::SetRating ( int rating )

inline

Set the user-defined rating of the current song.

SetTitle()

void kodi::addon::VisualizationTrack::SetTitle ( const std::string & title )

inline

Set title of the current song.

SetTrack()

void kodi::addon::VisualizationTrack::SetTrack ( int trackNumber )

inline

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

SetYear()

void kodi::addon::VisualizationTrack::SetYear ( int year )

inline

Set year that the current song was released.