Queue for video library jobs. More...

#include <VideoLibraryQueue.h>

Inheritance diagram for CVideoLibraryQueue:

Public Member Functions
	~CVideoLibraryQueue () override

void	ScanLibrary (const std::string &directory, bool scanAll=false, bool showProgress=true)
	Enqueue a library scan job. More...

bool	IsScanningLibrary () const
	Check if a library scan is in progress. More...

void	StopLibraryScanning ()
	Stop and dequeue all scanning jobs. More...

void	CleanLibrary (const std::set< int > &paths=std::set< int >(), bool asynchronous=true, CGUIDialogProgressBarHandle *progressBar=NULL)
	Enqueue a library cleaning job. More...

void	CleanLibraryModal (const std::set< int > &paths=std::set< int >())
	Executes a library cleaning with a modal dialog. More...

void	RefreshItem (CFileItemPtr item, bool ignoreNfo=false, bool forceRefresh=true, bool refreshAll=false, const std::string &searchTitle="")
	Enqueues a job to refresh the details of the given item. More...

bool	RefreshItemModal (CFileItemPtr item, bool forceRefresh=true, bool refreshAll=false)
	Refreshes the details of the given item with a modal dialog. More...

void	MarkAsWatched (const CFileItemPtr &item, bool watched)
	Queue a watched status update job. More...

void	ResetResumePoint (const CFileItemPtr item)
	Queue a reset resume point job. More...

void	AddJob (CVideoLibraryJob *job)
	Adds the given job to the queue. More...

void	CancelJob (CVideoLibraryJob *job)
	Cancels the given job and removes it from the queue. More...

void	CancelAllJobs ()
	Cancels all running and queued jobs. More...

bool	IsRunning () const
	Whether any jobs are running or not. More...

Static Public Member Functions
static CVideoLibraryQueue &	GetInstance ()
	Gets the singleton instance of the video library queue. More...

Protected Member Functions
void	OnJobComplete (unsigned int jobID, bool success, CJob *job) override
	The callback used when a job completes. More...

void	Refresh ()
	Notifies all to refresh the current listings. More...

Protected Member Functions inherited from CJobQueue
bool	QueueEmpty () const
	Returns if we still have jobs waiting to be processed NOTE: This function does not take into account the jobs that are currently processing. More...

	CJobQueue (bool lifo=false, unsigned int jobsAtOnce=1, CJob::PRIORITY priority=CJob::PRIORITY_LOW)
	CJobQueue constructor. More...

	~CJobQueue () override
	CJobQueue destructor Cancels any in-process jobs, and destroys the job queue. More...

bool	AddJob (CJob *job)
	Add a job to the queue On completion of the job (or destruction of the job queue) the CJob object will be destroyed. More...

template<typename F >
void	Submit (F &&f)
	Add a function f to this job queue. More...

void	CancelJob (const CJob *job)
	Cancel a job in the queue Cancels a job in the queue. Any job currently being processed may complete after this call has completed, but OnJobComplete will not be performed. If the job is only queued then it will be removed from the queue and deleted. More...

void	CancelJobs ()
	Cancel all jobs in the queue Removes all jobs from the queue. Any job currently being processed may complete after this call has completed, but OnJobComplete will not be performed. More...

bool	IsProcessing () const
	Check whether the queue is processing a job. More...

Protected Member Functions inherited from IJobCallback
virtual	~IJobCallback ()=default
	Destructor for job call back objects. More...

virtual void	OnJobProgress (unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job)
	An optional callback function that a job may call while processing. More...

Detailed Description

Queue for video library jobs.

The queue can only process a single job at any time and every job will be executed at the lowest priority.

Constructor & Destructor Documentation

◆ ~CVideoLibraryQueue()

CVideoLibraryQueue::~CVideoLibraryQueue ( )

override

Member Function Documentation

◆ AddJob()

void CVideoLibraryQueue::AddJob ( CVideoLibraryJob * job )

Adds the given job to the queue.

Parameters

[in] job Video library job to be queued.

◆ CancelAllJobs()

void CVideoLibraryQueue::CancelAllJobs ( )

Cancels all running and queued jobs.

◆ CancelJob()

void CVideoLibraryQueue::CancelJob ( CVideoLibraryJob * job )

Cancels the given job and removes it from the queue.

Parameters

[in] job Video library job to be canceled and removed from the queue.

◆ CleanLibrary()

void CVideoLibraryQueue::CleanLibrary	(	const std::set< int > &	paths = `std::set<int>()`,
		bool	asynchronous = `true`,
		CGUIDialogProgressBarHandle *	progressBar = `NULL`
	)

Enqueue a library cleaning job.

Parameters

[in]	paths	Set with database IDs of paths to be cleaned
[in]	asynchronous	Run the clean job asynchronously. Defaults to true
[in]	progressBar	Progress bar to update in GUI. Defaults to NULL (no progress bar to update)

◆ CleanLibraryModal()

void CVideoLibraryQueue::CleanLibraryModal ( const std::set< int > & paths = std::set<int>() )

Executes a library cleaning with a modal dialog.

Parameters

[in] paths Set with database IDs of paths to be cleaned

◆ GetInstance()

CVideoLibraryQueue & CVideoLibraryQueue::GetInstance ( )

static

Gets the singleton instance of the video library queue.

◆ IsRunning()

bool CVideoLibraryQueue::IsRunning ( ) const

Whether any jobs are running or not.

◆ IsScanningLibrary()

bool CVideoLibraryQueue::IsScanningLibrary ( ) const

Check if a library scan is in progress.

Returns: True if a scan is in progress, false otherwise

◆ MarkAsWatched()

void CVideoLibraryQueue::MarkAsWatched	(	const CFileItemPtr &	item,
		bool	watched
	)

Queue a watched status update job.

Parameters

[in]	item	Item to update watched status for
[in]	watched	New watched status

◆ OnJobComplete()

void CVideoLibraryQueue::OnJobComplete	(	unsigned int	jobID,
		bool	success,
		CJob *	job
	)

overrideprotectedvirtual

The callback used when a job completes.

OnJobComplete is called at the completion of the CJob::DoWork function, and is used to return information to the caller on the result of the job. On returning from this function the CJobManager will destroy this job.

Subclasses should override this function if they wish to transfer information from the job prior to it's deletion. They must then call this base class function, which will move on to the next job.

See also: CJobManager, IJobCallback and CJob

Reimplemented from CJobQueue.

◆ Refresh()

void CVideoLibraryQueue::Refresh ( )

protected

Notifies all to refresh the current listings.

◆ RefreshItem()

void CVideoLibraryQueue::RefreshItem	(	CFileItemPtr	item,
		bool	ignoreNfo = `false`,
		bool	forceRefresh = `true`,
		bool	refreshAll = `false`,
		const std::string &	searchTitle = `""`
	)

Enqueues a job to refresh the details of the given item.

Parameters

[in,out]	item	Video item to be refreshed
[in]	ignoreNfo	Whether or not to ignore local NFO files
[in]	forceRefresh	Whether to force a complete refresh (including NFO or internet lookup)
[in]	refreshAll	Whether to refresh all sub-items (in case of a tvshow)
[in]	searchTitle	Title to use for the search (instead of determining it from the item's filename/path)

◆ RefreshItemModal()

bool CVideoLibraryQueue::RefreshItemModal	(	CFileItemPtr	item,
		bool	forceRefresh = `true`,
		bool	refreshAll = `false`
	)

Refreshes the details of the given item with a modal dialog.

Parameters

[in,out]	item	Video item to be refreshed
[in]	forceRefresh	Whether to force a complete refresh (including NFO or internet lookup)
[in]	refreshAll	Whether to refresh all sub-items (in case of a tvshow)

Returns: True if the item has been successfully refreshed, false otherwise.

◆ ResetResumePoint()

void CVideoLibraryQueue::ResetResumePoint ( const CFileItemPtr item )

Queue a reset resume point job.

Parameters

[in] item Item to reset the resume point for

◆ ScanLibrary()

void CVideoLibraryQueue::ScanLibrary	(	const std::string &	directory,
		bool	scanAll = `false`,
		bool	showProgress = `true`
	)

Enqueue a library scan job.

Parameters

[in]	directory	Directory to scan
[in]	scanAll	Ignore exclude setting for items. Defaults to false
[in]	showProgress	Whether or not to show a progress dialog. Defaults to true

◆ StopLibraryScanning()

void CVideoLibraryQueue::StopLibraryScanning ( )

Stop and dequeue all scanning jobs.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~CVideoLibraryQueue()

Member Function Documentation

◆ AddJob()

◆ CancelAllJobs()

◆ CancelJob()

◆ CleanLibrary()

◆ CleanLibraryModal()

◆ GetInstance()

◆ IsRunning()

◆ IsScanningLibrary()

◆ MarkAsWatched()

◆ OnJobComplete()

◆ Refresh()

◆ RefreshItem()

◆ RefreshItemModal()

◆ ResetResumePoint()

◆ ScanLibrary()

◆ StopLibraryScanning()