Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
Info tag data structure
Representation of available information of processed audio file.
More...
Topics | |
Value Help | |
Classes | |
class | kodi::addon::AudioDecoderInfoTag |
Functions | |
void | kodi::addon::AudioDecoderInfoTag::SetTitle (const std::string &title) |
Set the title from music as string on info tag. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetTitle () const |
Get title name. | |
void | kodi::addon::AudioDecoderInfoTag::SetArtist (const std::string &artist) |
Set artist name. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetArtist () const |
Get artist name. | |
void | kodi::addon::AudioDecoderInfoTag::SetAlbum (const std::string &album) |
Set album name. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetAlbum () const |
Set album name. | |
void | kodi::addon::AudioDecoderInfoTag::SetAlbumArtist (const std::string &albumArtist) |
Set album artist name. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetAlbumArtist () const |
Get album artist name. | |
void | kodi::addon::AudioDecoderInfoTag::SetMediaType (const std::string &mediaType) |
Set the media type of the music item. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetMediaType () const |
Get the media type of the music item. | |
void | kodi::addon::AudioDecoderInfoTag::SetGenre (const std::string &genre) |
Set genre name from music as string if present. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetGenre () const |
Get genre name from music as string if present. | |
void | kodi::addon::AudioDecoderInfoTag::SetDuration (int duration) |
Set the duration of music as integer from info. | |
int | kodi::addon::AudioDecoderInfoTag::GetDuration () const |
Get the duration of music as integer from info. | |
void | kodi::addon::AudioDecoderInfoTag::SetTrack (int track) |
Set track number (if present) from music info as integer. | |
int | kodi::addon::AudioDecoderInfoTag::GetTrack () const |
Get track number (if present). | |
void | kodi::addon::AudioDecoderInfoTag::SetDisc (int disc) |
Set disk number (if present) from music info as integer. | |
int | kodi::addon::AudioDecoderInfoTag::GetDisc () const |
Get disk number (if present) | |
void | kodi::addon::AudioDecoderInfoTag::SetDiscSubtitle (const std::string &discSubtitle) |
Set disk subtitle name (if present) from music info. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetDiscSubtitle () const |
Get disk subtitle name (if present) from music info. | |
void | kodi::addon::AudioDecoderInfoTag::SetDiscTotal (int discTotal) |
Set disks amount quantity (if present) from music info as integer. | |
int | kodi::addon::AudioDecoderInfoTag::GetDiscTotal () const |
Get disks amount quantity (if present) | |
void | kodi::addon::AudioDecoderInfoTag::SetReleaseDate (const std::string &releaseDate) |
Set release date as string from music info (if present). ISO8601 date YYYY, YYYY-MM or YYYY-MM-DD. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetReleaseDate () const |
Get release date as string from music info (if present). | |
void | kodi::addon::AudioDecoderInfoTag::SetLyrics (const std::string &lyrics) |
Set string from lyrics. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetLyrics () const |
Get string from lyrics. | |
void | kodi::addon::AudioDecoderInfoTag::SetSamplerate (int samplerate) |
Set related stream samplerate. | |
int | kodi::addon::AudioDecoderInfoTag::GetSamplerate () const |
Get related stream samplerate. | |
void | kodi::addon::AudioDecoderInfoTag::SetChannels (int channels) |
Set related stream channels amount. | |
int | kodi::addon::AudioDecoderInfoTag::GetChannels () const |
Get related stream channels amount. | |
void | kodi::addon::AudioDecoderInfoTag::SetBitrate (int bitrate) |
Set related stream bitrate. | |
int | kodi::addon::AudioDecoderInfoTag::GetBitrate () const |
Get related stream bitrate. | |
void | kodi::addon::AudioDecoderInfoTag::SetComment (const std::string &comment) |
Set additional information comment (if present). | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetComment () const |
Get additional information comment (if present). | |
void | kodi::addon::AudioDecoderInfoTag::SetCoverArtByPath (const std::string &path) |
Set cover art image by path. | |
const std::string & | kodi::addon::AudioDecoderInfoTag::GetCoverArtByPath () const |
Get cover art image path. | |
void | kodi::addon::AudioDecoderInfoTag::SetCoverArtByMem (const uint8_t *data, size_t size, const std::string &mimetype) |
Set cover art image by memory. | |
const uint8_t * | kodi::addon::AudioDecoderInfoTag::GetCoverArtByMem (size_t &size, std::string &mimetype) const |
Get cover art data by memory. | |
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 |
Cover art by path | std::string | SetCoverArtByPath | GetCoverArtByPath |
Cover art by memory | std::string | SetCoverArtByMem | GetCoverArtByMem |
|
inline |
Set album name.
|
inline |
Get album artist name.
|
inline |
Get artist name.
|
inline |
Get related stream bitrate.
|
inline |
Get related stream channels amount.
|
inline |
Get additional information comment (if present).
|
inline |
Get cover art data by memory.
[out] | size | Stored size about art image |
[in] | mimetype | Related image mimetype to stored data |
|
inline |
Get cover art image path.
|
inline |
Get disk number (if present)
|
inline |
Get disk subtitle name (if present) from music info.
|
inline |
Get disks amount quantity (if present)
|
inline |
Get the duration of music as integer from info.
|
inline |
Get genre name from music as string if present.
|
inline |
Get string from lyrics.
|
inline |
Get the media type of the music item.
|
inline |
Get release date as string from music info (if present).
|
inline |
Get related stream samplerate.
|
inline |
Get title name.
|
inline |
Get track number (if present).
|
inline |
Set album name.
|
inline |
Set album artist name.
|
inline |
Set artist name.
Set related stream channels amount.
|
inline |
Set additional information comment (if present).
|
inline |
Set cover art image by memory.
[in] | data | Image data |
[in] | size | Image data size |
[in] | mimetype | Image format mimetype Possible mimetypes:
|
|
inline |
Set cover art image by path.
[in] | path | Image position path |
Set disk number (if present) from music info as integer.
|
inline |
Set disk subtitle name (if present) from music info.
Set disks amount quantity (if present) from music info as integer.
Set the duration of music as integer from info.
|
inline |
Set genre name from music as string if present.
|
inline |
Set string from lyrics.
|
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 |
|
inline |
Set release date as string from music info (if present).
ISO8601 date YYYY, YYYY-MM or YYYY-MM-DD.
Set related stream samplerate.
|
inline |
Set the title from music as string on info tag.