CVideoThumbLoader Class Reference

#include <VideoThumbLoader.h>

Inheritance diagram for CVideoThumbLoader:

Public Member Functions
	CVideoThumbLoader ()
	~CVideoThumbLoader () override
void	OnLoaderStart () override
void	OnLoaderFinish () override
bool	LoadItem (CFileItem *pItem) override
bool	LoadItemCached (CFileItem *pItem) override
bool	LoadItemLookup (CFileItem *pItem) override
virtual bool	FillThumb (CFileItem &item)
	Fill the thumb of a video item First uses a cached thumb from a previous run, then checks for a local thumb and caches it for the next run.
bool	FillLibraryArt (CFileItem &item) override
	helper function to fill the art for a video library item
Public Member Functions inherited from CThumbLoader
	CThumbLoader ()
	~CThumbLoader () override
virtual std::string	GetCachedImage (const CFileItem &item, const std::string &type)
	Checks whether the given item has an image listed in the texture database.
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.
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)
void	StopThread ()
void	StopAsync ()
Public Member Functions inherited from IRunnable
virtual void	Cancel ()
virtual	~IRunnable ()=default

Static Public Member Functions
static std::string	GetLocalArt (const CFileItem &item, const std::string &type, bool checkFolder=false)
	Find a particular art type for a given item, optionally checking at the folder level.
static std::vector< std::string >	GetArtTypes (const std::string &type)
	return the available art types for a given media type
static bool	IsValidArtType (const std::string &potentialArtType)
static bool	IsArtTypeInWhitelist (const std::string &artType, const std::vector< std::string > &whitelist, bool exact)
static std::string	GetEmbeddedThumbURL (const CFileItem &item)
	helper function to retrieve a thumb URL for embedded video thumbs

Protected Member Functions
void	DetectAndAddMissingItemData (CFileItem &item)
	Tries to detect missing data/info from a file and adds those.
const ArtMap &	GetArtFromCache (const std::string &mediaType, const int id)

Protected Attributes
CVideoDatabase *	m_videoDatabase
ArtCache	m_artCache
Protected Attributes inherited from CThumbLoader
CTextureDatabase *	m_textureDatabase
Protected Attributes inherited from CBackgroundInfoLoader
CFileItemList *	m_pVecItems {nullptr}
std::vector< CFileItemPtr >	m_vecItems
CCriticalSection	m_lock
volatile bool	m_bIsLoading {false}
volatile bool	m_bStop {true}
CThread *	m_thread {nullptr}
IBackgroundLoaderObserver *	m_pObserver {nullptr}
IProgressCallback *	m_pProgressCallback {nullptr}

Constructor & Destructor Documentation

CVideoThumbLoader()

CVideoThumbLoader::CVideoThumbLoader

(

)

~CVideoThumbLoader()

CVideoThumbLoader::~CVideoThumbLoader ( )

override

Member Function Documentation

DetectAndAddMissingItemData()

void CVideoThumbLoader::DetectAndAddMissingItemData ( CFileItem & item )

protected

Tries to detect missing data/info from a file and adds those.

Parameters

item	The CFileItem to process

Returns

void

Todo

in case of too many false positives due to using the full path, extract the filename only using string utils

FillLibraryArt()

bool CVideoThumbLoader::FillLibraryArt ( CFileItem & item )

overridevirtual

helper function to fill the art for a video library item

Parameters

item	a video CFileItem

Returns

true if we fill art, false otherwise

Todo

Is m_artist set other than musicvideo? Remove this fallback if not.

Reimplemented from CThumbLoader.

FillThumb()

bool CVideoThumbLoader::FillThumb ( CFileItem & item )

virtual

Fill the thumb of a video item First uses a cached thumb from a previous run, then checks for a local thumb and caches it for the next run.

Parameters

item	the CFileItem object to fill

Returns

true if we fill the thumb, false otherwise

GetArtFromCache()

const ArtMap & CVideoThumbLoader::GetArtFromCache ( const std::string & mediaType, const int id )

protected

GetArtTypes()

std::vector< std::string > CVideoThumbLoader::GetArtTypes ( const std::string & type )

static

return the available art types for a given media type

Parameters

type	the type of media.

Returns

a vector of art types.

See also

GetLocalArt

GetEmbeddedThumbURL()

std::string CVideoThumbLoader::GetEmbeddedThumbURL ( const CFileItem & item )

static

helper function to retrieve a thumb URL for embedded video thumbs

Parameters

item	a video CFileItem.

Returns

a URL for the embedded thumb.

GetLocalArt()

std::string CVideoThumbLoader::GetLocalArt ( const CFileItem & item, const std::string & type, bool checkFolder = false )

static

Find a particular art type for a given item, optionally checking at the folder level.

Parameters

item	the CFileItem to search.
type	the type of art to look for.
checkFolder	whether to also check the folder level for files. Defaults to false.

Returns

the art file (if found), else empty.

IsArtTypeInWhitelist()

bool CVideoThumbLoader::IsArtTypeInWhitelist ( const std::string & artType, const std::vector< std::string > & whitelist, bool exact )

static

IsValidArtType()

bool CVideoThumbLoader::IsValidArtType ( const std::string & potentialArtType )

static

LoadItem()

bool CVideoThumbLoader::LoadItem ( CFileItem * pItem )

overridevirtual

Look for a thumbnail for pItem. If one does not exist, look for an autogenerated thumbnail. If that does not exist, attempt to autogenerate one. Finally, check for the existence of fanart and set properties accordingly.

Returns

: true if pItem has been modified

Reimplemented from CBackgroundInfoLoader.

LoadItemCached()

bool CVideoThumbLoader::LoadItemCached ( CFileItem * pItem )

overridevirtual

Reimplemented from CBackgroundInfoLoader.

LoadItemLookup()

bool CVideoThumbLoader::LoadItemLookup ( CFileItem * pItem )

overridevirtual

Reimplemented from CBackgroundInfoLoader.

OnLoaderFinish()

void CVideoThumbLoader::OnLoaderFinish ( )

overridevirtual

Reimplemented from CThumbLoader.

OnLoaderStart()

void CVideoThumbLoader::OnLoaderStart ( )

overridevirtual

Reimplemented from CThumbLoader.

Member Data Documentation

m_artCache

ArtCache CVideoThumbLoader::m_artCache

protected

m_videoDatabase

CVideoDatabase* CVideoThumbLoader::m_videoDatabase

protected

---

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

• VideoThumbLoader.h
• VideoThumbLoader.cpp