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

Thumb extractor job class. More...

#include <VideoThumbLoader.h>

Inheritance diagram for CThumbExtractor:
CJob

Public Member Functions

 CThumbExtractor (const CFileItem &item, const std::string &listpath, bool thumb, const std::string &strTarget="", int64_t pos=-1, bool fillStreamDetails=true)
 
 ~CThumbExtractor () override
 
bool DoWork () override
 Work function that extracts thumb. More...
 
const char * GetType () const override
 Function that returns the type of job. More...
 
bool operator== (const CJob *job) const override
 
- Public Member Functions inherited from CJob
 CJob ()
 
virtual ~CJob ()=default
 Destructor for job objects. More...
 
virtual bool ShouldCancel (unsigned int progress, unsigned int total) const
 Function for longer jobs to report progress and check whether they have been cancelled. More...
 

Public Attributes

std::string m_target
 thumbpath More...
 
std::string m_listpath
 path used in fileitem list More...
 
CFileItem m_item
 
bool m_thumb
 extract thumb? More...
 
int64_t m_pos
 position to extract thumb from More...
 
bool m_fillStreamDetails
 fill in stream details? More...
 

Additional Inherited Members

- Public Types inherited from CJob
enum  PRIORITY {
  PRIORITY_LOW_PAUSABLE = 0 , PRIORITY_LOW , PRIORITY_NORMAL , PRIORITY_HIGH ,
  PRIORITY_DEDICATED
}
 Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...
 

Detailed Description

Thumb extractor job class.

,

Used by the CVideoThumbLoader to perform asynchronous generation of thumbs

See also
CVideoThumbLoader and CJob

Constructor & Destructor Documentation

◆ CThumbExtractor()

CThumbExtractor::CThumbExtractor ( const CFileItem item,
const std::string &  listpath,
bool  thumb,
const std::string &  strTarget = "",
int64_t  pos = -1,
bool  fillStreamDetails = true 
)

◆ ~CThumbExtractor()

CThumbExtractor::~CThumbExtractor ( )
overridedefault

Member Function Documentation

◆ DoWork()

bool CThumbExtractor::DoWork ( void  )
overridevirtual

Work function that extracts thumb.

Implements CJob.

◆ GetType()

const char * CThumbExtractor::GetType ( ) const
inlineoverridevirtual

Function that returns the type of job.

CJob subclasses may optionally implement this function to specify the type of job. This is useful for the CJobManager::AddLIFOJob() routine, which preempts similar jobs with the new job.

Returns
a unique character string describing the job.
See also
CJobManager

Reimplemented from CJob.

◆ operator==()

bool CThumbExtractor::operator== ( const CJob job) const
overridevirtual

Reimplemented from CJob.

Member Data Documentation

◆ m_fillStreamDetails

bool CThumbExtractor::m_fillStreamDetails

fill in stream details?

◆ m_item

CFileItem CThumbExtractor::m_item

◆ m_listpath

std::string CThumbExtractor::m_listpath

path used in fileitem list

◆ m_pos

int64_t CThumbExtractor::m_pos

position to extract thumb from

◆ m_target

std::string CThumbExtractor::m_target

thumbpath

◆ m_thumb

bool CThumbExtractor::m_thumb

extract thumb?


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