Video library job implementation for resetting a resume point. More...

#include <VideoLibraryResetResumePointJob.h>

Inheritance diagram for CVideoLibraryResetResumePointJob:

Collaboration diagram for CVideoLibraryResetResumePointJob:

Public Member Functions
	CVideoLibraryResetResumePointJob (const std::shared_ptr< CFileItem > &item)
	Creates a new job for resetting a given item's resume point. 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 CVideoLibraryJob
virtual bool	CanBeCancelled () const
	Whether the job can be cancelled or not.

virtual bool	Cancel ()
	Tries to cancel the running job. More...

bool	DoWork () override
	Main workhorse function of CJob instances. More...

Public Member Functions inherited from 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...

Protected Member Functions
bool	Work (CVideoDatabase &db) override
	Worker method to be implemented by an actual implementation. 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

Video library job implementation for resetting a resume point.

Constructor & Destructor Documentation

◆ CVideoLibraryResetResumePointJob()

CVideoLibraryResetResumePointJob::CVideoLibraryResetResumePointJob ( const std::shared_ptr< CFileItem > & item )

Creates a new job for resetting a given item's resume point.

Parameters

[in] item Item for that the resume point shall be reset.

Member Function Documentation

◆ GetType()

const char* CVideoLibraryResetResumePointJob::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 CVideoLibraryJob.

◆ Work()

bool CVideoLibraryResetResumePointJob::Work ( CVideoDatabase & db )

overrideprotectedvirtual

Worker method to be implemented by an actual implementation.

Parameters

[in] db Already open video database to be used for interaction

Returns: True if the process succeeded, false otherwise

Implements CVideoLibraryJob.

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

xbmc/video/jobs/VideoLibraryResetResumePointJob.h
xbmc/video/jobs/VideoLibraryResetResumePointJob.cpp

Public Member Functions