Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
MUSIC_UTILS::CSetSongRatingJob Class Reference
Inheritance diagram for MUSIC_UTILS::CSetSongRatingJob:
CJob

Public Member Functions

 CSetSongRatingJob (const std::string &filePath, int userrating)
 
 CSetSongRatingJob (int songId, int userrating)
 
 ~CSetSongRatingJob (void) override=default
 
bool DoWork (void) override
 Main workhorse function of CJob instances.
 
- Public Member Functions inherited from CJob
 CJob ()
 
virtual ~CJob ()=default
 Destructor for job objects.
 
virtual const char * GetType () const
 Function that returns the type of job.
 
virtual bool operator== (const CJob *job) const
 
virtual bool ShouldCancel (unsigned int progress, unsigned int total) const
 Function for longer jobs to report progress and check whether they have been cancelled.
 

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...
 

Constructor & Destructor Documentation

◆ CSetSongRatingJob() [1/2]

MUSIC_UTILS::CSetSongRatingJob::CSetSongRatingJob ( const std::string & filePath,
int userrating )
inline

◆ CSetSongRatingJob() [2/2]

MUSIC_UTILS::CSetSongRatingJob::CSetSongRatingJob ( int songId,
int userrating )
inline

◆ ~CSetSongRatingJob()

MUSIC_UTILS::CSetSongRatingJob::~CSetSongRatingJob ( void )
overridedefault

Member Function Documentation

◆ DoWork()

bool MUSIC_UTILS::CSetSongRatingJob::DoWork ( void )
inlineoverridevirtual

Main workhorse function of CJob instances.

All CJob subclasses must implement this function, performing all processing. Once this function is complete, the OnJobComplete() callback is called, and the job is then destroyed.

See also
CJobManager, IJobCallback::OnJobComplete()

Implements CJob.


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