Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CThumbLoader Class Reference

#include <ThumbLoader.h>

Inheritance diagram for CThumbLoader:
CBackgroundInfoLoader IRunnable CMusicThumbLoader CPictureThumbLoader CProgramThumbLoader CVideoThumbLoader

Public Member Functions

 CThumbLoader ()
 
 ~CThumbLoader () override
 
void OnLoaderStart () override
 
void OnLoaderFinish () override
 
virtual bool FillLibraryArt (CFileItem &item)
 helper function to fill the art for a library item More...
 
virtual std::string GetCachedImage (const CFileItem &item, const std::string &type)
 Checks whether the given item has an image listed in the texture database. More...
 
virtual void SetCachedImage (const CFileItem &item, const std::string &type, const std::string &image)
 Associate an image with the given item in the texture database. More...
 
- Public Member Functions inherited from CBackgroundInfoLoader
 CBackgroundInfoLoader ()
 
 ~CBackgroundInfoLoader () override
 
void Load (CFileItemList &items)
 
bool IsLoading ()
 
void Run () override
 
void SetObserver (IBackgroundLoaderObserver *pObserver)
 
void SetProgressCallback (IProgressCallback *pCallback)
 
virtual bool LoadItem (CFileItem *pItem)
 
virtual bool LoadItemCached (CFileItem *pItem)
 
virtual bool LoadItemLookup (CFileItem *pItem)
 
void StopThread ()
 
void StopAsync ()
 
- Public Member Functions inherited from IRunnable
virtual void Cancel ()
 
virtual ~IRunnable ()=default
 

Protected Attributes

CTextureDatabasem_textureDatabase
 
- Protected Attributes inherited from CBackgroundInfoLoader
CFileItemListm_pVecItems
 
std::vector< CFileItemPtrm_vecItems
 
CCriticalSection m_lock
 
volatile bool m_bIsLoading
 
volatile bool m_bStop
 
CThreadm_thread
 
IBackgroundLoaderObserverm_pObserver
 
IProgressCallbackm_pProgressCallback
 

Additional Inherited Members

Constructor & Destructor Documentation

◆ CThumbLoader()

CThumbLoader::CThumbLoader ( )

◆ ~CThumbLoader()

CThumbLoader::~CThumbLoader ( )
override

Member Function Documentation

◆ FillLibraryArt()

virtual bool CThumbLoader::FillLibraryArt ( CFileItem item)
inlinevirtual

helper function to fill the art for a library item

Parameters
itema CFileItem
Returns
true if we fill art, false otherwise

Reimplemented in CMusicThumbLoader, and CVideoThumbLoader.

◆ GetCachedImage()

std::string CThumbLoader::GetCachedImage ( const CFileItem item,
const std::string &  type 
)
virtual

Checks whether the given item has an image listed in the texture database.

Parameters
itemCFileItem to check
typethe type of image to retrieve
Returns
the image associated with this item

◆ OnLoaderFinish()

void CThumbLoader::OnLoaderFinish ( )
overridevirtual

Reimplemented from CBackgroundInfoLoader.

Reimplemented in CVideoThumbLoader.

◆ OnLoaderStart()

void CThumbLoader::OnLoaderStart ( )
overridevirtual

Reimplemented from CBackgroundInfoLoader.

Reimplemented in CVideoThumbLoader.

◆ SetCachedImage()

void CThumbLoader::SetCachedImage ( const CFileItem item,
const std::string &  type,
const std::string &  image 
)
virtual

Associate an image with the given item in the texture database.

Parameters
itemCFileItem to associate the image with
typethe type of image
imagethe URL of the image

Member Data Documentation

◆ m_textureDatabase

CTextureDatabase* CThumbLoader::m_textureDatabase
protected

The documentation for this class was generated from the following files: