Kodi Development  20.0
for Binary and Script based Add-Ons

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.


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

Name Type Set call Get call
Title std::string SetTitle GetTitle
Artist std::string SetArtist GetArtist
Album std::string SetAlbum GetAlbum
Album artist std::string SetAlbumArtist GetAlbumArtist
Media type std::string SetMediaType GetMediaType
Genre std::string SetGenre GetGenre
Duration int SetDuration GetDuration
Track number int SetTrack GetTrack
Disc number int SetDisc GetDisc
Disc subtitle name std::string SetDiscSubtitle GetDiscSubtitle
Disc total amount int SetDiscTotal GetDiscTotal
Release date std::string SetReleaseDate GetReleaseDate
Lyrics std::string SetLyrics GetLyrics
Samplerate int SetSamplerate GetSamplerate
Channels amount int SetChannels GetChannels
Bitrate int SetBitrate GetBitrate
Comment text std::string SetComment GetComment

Modules

 Value Help
 

Function Documentation

◆ SetTitle()

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

Set the title from music as string on info tag.

◆ GetTitle()

std::string GetTitle ( ) const
inline

Get title name.

◆ SetArtist()

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

Set artist name.

◆ GetArtist()

std::string GetArtist ( ) const
inline

Get artist name.

◆ SetAlbum()

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

Set album name.

◆ GetAlbum()

std::string GetAlbum ( ) const
inline

Set album name.

◆ SetAlbumArtist()

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

Set album artist name.

◆ GetAlbumArtist()

std::string GetAlbumArtist ( ) const
inline

Get album artist name.

◆ SetMediaType()

void SetMediaType ( const std::string &  mediaType)
inline

Set the media type of the music item.

Available strings about media type for music:

String Description
artist If it is defined as an artist
album If it is defined as an album
music If it is defined as an music
song If it is defined as a song

◆ GetMediaType()

std::string GetMediaType ( ) const
inline

Get the media type of the music item.

◆ SetGenre()

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

Set genre name from music as string if present.

◆ GetGenre()

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  track)
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  disc)
inline

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

◆ GetDisc()

int GetDisc ( ) const
inline

Get disk number (if present)

◆ SetDiscSubtitle()

void SetDiscSubtitle ( const std::string &  discSubtitle)
inline

Set disk subtitle name (if present) from music info.

◆ GetDiscSubtitle()

std::string GetDiscSubtitle ( ) const
inline

Get disk subtitle name (if present) from music info.

◆ SetDiscTotal()

void SetDiscTotal ( int  discTotal)
inline

Set disks amount quantity (if present) from music info as integer.

◆ GetDiscTotal()

int GetDiscTotal ( ) const
inline

Get disks amount quantity (if present)

◆ SetReleaseDate()

void SetReleaseDate ( const std::string &  releaseDate)
inline

Set release date as string from music info (if present).
ISO8601 date YYYY, YYYY-MM or YYYY-MM-DD.

◆ GetReleaseDate()

std::string GetReleaseDate ( ) const
inline

Get release date as string from music info (if present).

◆ SetLyrics()

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

Set string from lyrics.

◆ GetLyrics()

std::string GetLyrics ( ) const
inline

Get string from lyrics.

◆ SetSamplerate()

void SetSamplerate ( int  samplerate)
inline

Set related stream samplerate.

◆ GetSamplerate()

int GetSamplerate ( ) const
inline

Get related stream samplerate.

◆ SetChannels()

void SetChannels ( int  channels)
inline

Set related stream channels amount.

◆ GetChannels()

int GetChannels ( ) const
inline

Get related stream channels amount.

◆ SetBitrate()

void SetBitrate ( int  bitrate)
inline

Set related stream bitrate.

◆ GetBitrate()

int GetBitrate ( ) const
inline

Get related stream bitrate.

◆ SetComment()

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

Set additional information comment (if present).

◆ GetComment()

std::string GetComment ( ) const
inline

Get additional information comment (if present).