|
Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
|
Measure the content geometry of every library file that does not have one. The work list is recomputed from the database on each run, so the job is resumable. More...
#include <VideoLibraryContentGeometryJob.h>
Public Member Functions | |
| CVideoLibraryContentGeometryJob (bool retryFailed) | |
retryFailed also measures files a previous run could not read, which is the only way to retry one that has not changed since. Off for the automatic sweeps. | |
| ~CVideoLibraryContentGeometryJob () override | |
| const char * | GetType () const override |
| Function that returns the type of job. | |
Public Member Functions inherited from CVideoLibraryProgressJob | |
| ~CVideoLibraryProgressJob () override | |
| bool | DoWork () override |
| Main workhorse function of CJob instances. | |
| const char * | GetType () const override |
| Function that returns the type of job. | |
Public Member Functions inherited from CProgressJob | |
| ~CProgressJob () override | |
| bool | ShouldCancel (unsigned int progress, unsigned int total) const override |
| Function for longer jobs to report progress and check whether they have been cancelled. | |
| bool | DoModal () |
| Executes the job showing a modal progress dialog. | |
| void | SetProgressIndicators (CGUIDialogProgressBarHandle *progressBar, CGUIDialogProgress *progressDialog, bool updateProgress=true, bool updateInformation=true) |
| Sets the given progress indicators to be used during execution of the job. | |
| bool | HasProgressIndicator () const |
Public Member Functions inherited from CJob | |
| CJob ()=default | |
| virtual | ~CJob ()=default |
| Destructor for job objects. | |
| virtual bool | Equals (const CJob *job) const |
| Function that compares this job instance with the given job instance. | |
| void | SetProgressCallback (CJobManager *callback) |
| Function to set a callback for jobs to report progress. | |
| size_t | GetPendingCallbackCount () const |
| Get the number of callbacks pending for this job during completion. | |
Public Member Functions inherited from CVideoLibraryJob | |
| ~CVideoLibraryJob () override | |
| virtual bool | CanBeCancelled () const |
| Whether the job can be cancelled or not. | |
| virtual bool | Cancel () |
| Tries to cancel the running job. | |
Protected Member Functions | |
| bool | Work (CVideoDatabase &db) override |
| Worker method to be implemented by an actual implementation. | |
Protected Member Functions inherited from CVideoLibraryProgressJob | |
| CVideoLibraryProgressJob (CGUIDialogProgressBarHandle *progressBar) | |
Protected Member Functions inherited from CProgressJob | |
| CProgressJob ()=default | |
| CProgressJob (CGUIDialogProgressBarHandle *progressBar) | |
| bool | IsModal () const |
| Whether the job is being run modally or in the background. | |
| CGUIDialogProgressBarHandle * | GetProgressBar () const |
| Returns the progress bar indicating the progress of the job. | |
| void | SetProgressBar (CGUIDialogProgressBarHandle *progress) |
| Sets the progress bar indicating the progress of the job. | |
| CGUIDialogProgress * | GetProgressDialog () const |
| Returns the progress dialog indicating the progress of the job. | |
| void | SetProgressDialog (CGUIDialogProgress *progressDialog) |
| Sets the progress bar indicating the progress of the job. | |
| bool | GetAutoClose () |
| Whether to automatically close the progress indicator in MarkFinished(). | |
| void | SetAutoClose (bool autoClose) |
| Set whether to automatically close the progress indicator in MarkFinished(). | |
| bool | GetUpdateProgress () |
| Whether to update the progress bar or not. | |
| void | SetUpdateProgress (bool updateProgress) |
| Set whether to update the progress bar or not. | |
| bool | GetUpdateInformation () |
| Whether to update the progress information or not. | |
| void | SetUpdateInformation (bool updateInformation) |
| Set whether to update the progress information or not. | |
| void | ShowProgressDialog () const |
| Makes sure that the modal dialog is being shown. | |
| void | SetTitle (const std::string &title) |
| Sets the given title as the title of the progress bar. | |
| void | SetText (const std::string &text) |
| Sets the given text as the description of the progress bar. | |
| void | SetProgress (float percentage) const |
| Sets the progress of the progress bar to the given value in percentage. | |
| void | SetProgress (int currentStep, int totalSteps) const |
| Sets the progress of the progress bar to the given value. | |
| void | MarkFinished () |
| Marks the progress as finished by setting it to 100%. | |
| bool | IsCancelled () const |
| Checks if the progress dialog has been cancelled. | |
Protected Member Functions inherited from CVideoLibraryJob | |
| CVideoLibraryJob () | |
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... | |
Measure the content geometry of every library file that does not have one. The work list is recomputed from the database on each run, so the job is resumable.
Playback and any other video library job suspend it between files, and the file being measured when playback starts is abandoned mid-sample. CContentGeometryScanner::StopSweep() ends it.
|
explicit |
retryFailed also measures files a previous run could not read, which is the only way to retry one that has not changed since. Off for the automatic sweeps.
|
overridedefault |
|
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::AddJob() routine, which preempts similar jobs with the new job.
Reimplemented from CProgressJob.
|
overrideprotectedvirtual |
Worker method to be implemented by an actual implementation.
| [in] | db | Already open video database to be used for interaction |
Implements CVideoLibraryJob.