KODI::ART Namespace Reference

Typedefs
using	Artwork = std::map< std::string, std::string, std::less<> >
	A container for artwork. key: artwork type, value: URL of artwork file.
using	SeasonsArtwork = std::map< int, Artwork >
	A container for artwork for multipe seasons. key: season number, value: artwork.

Functions
void	FillInDefaultIcon (CFileItem &item)
	Set default icon for item.
std::string	GetFolderThumb (const CFileItem &item, const std::string &folderJPG="folder.jpg")
	Get the folder image associated with item.
std::string	GetLocalArt (const CFileItem &item, const std::string &artFile, bool useFolder=false)
	Assemble the filename of a particular piece of local artwork for an item. No file existence check is typically performed.
std::string	GetLocalArtBaseFilename (const CFileItem &item, bool &useFolder)
	Assemble the base filename of local artwork for an item, accounting for archives, stacks and multi-paths, and BDMV/VIDEO_TS folders.
std::string	GetLocalFanart (const CFileItem &item)
	Get the local fanart for item if it exists.
std::string	GetTBNFile (const CFileItem &item)
	Get the .tbn file associated with an item.

Typedef Documentation

Artwork

using KODI::ART::Artwork = typedef std::map<std::string, std::string, std::less<> >

A container for artwork. key: artwork type, value: URL of artwork file.

SeasonsArtwork

using KODI::ART::SeasonsArtwork = typedef std::map<int, Artwork>

A container for artwork for multipe seasons. key: season number, value: artwork.

Function Documentation

FillInDefaultIcon()

void KODI::ART::FillInDefaultIcon

(

CFileItem &

item

)

Set default icon for item.

GetFolderThumb()

std::string KODI::ART::GetFolderThumb	(	const CFileItem &	item,
		const std::string &	folderJPG = "folder.jpg"
	)

Get the folder image associated with item.

Parameters

item	Item to get folder image for
folderJPG	Thumb file to use

Returns

Folder thumb file appropriate for item

GetLocalArt()

std::string KODI::ART::GetLocalArt	(	const CFileItem &	item,
		const std::string &	artFile,
		bool	useFolder = false
	)

Assemble the filename of a particular piece of local artwork for an item. No file existence check is typically performed.

Parameters

artFile	the art file to search for.
useFolder	whether to look in the folder for the art file. Defaults to false.

Returns

the path to the local artwork.

See also

FindLocalArt

GetLocalArtBaseFilename()

std::string KODI::ART::GetLocalArtBaseFilename	(	const CFileItem &	item,
		bool &	useFolder
	)

Assemble the base filename of local artwork for an item, accounting for archives, stacks and multi-paths, and BDMV/VIDEO_TS folders.

Parameters

useFolder

whether to look in the folder for the art file. Defaults to false.

Returns

the path to the base filename for artwork lookup.

See also

GetLocalArt

GetLocalFanart()

std::string KODI::ART::GetLocalFanart

(

const CFileItem &

item

)

Get the local fanart for item if it exists.

Returns

path to the local fanart for this item, or empty if none exists

See also

GetFolderThumb, GetTBNFile

GetTBNFile()

std::string KODI::ART::GetTBNFile

(

const CFileItem &

item

)

Get the .tbn file associated with an item.