tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
tracktion::engine::ThreadPoolJobWithProgress Class Referenceabstract
Inheritance diagram for tracktion::engine::ThreadPoolJobWithProgress:
juce::ThreadPoolJob tracktion::engine::AudioClipBase::TempoDetectTask tracktion::engine::AudioProxyGenerator::GeneratorJob tracktion::engine::ExportJob tracktion::engine::ExtractionTask tracktion::engine::RenderManager::Job tracktion::engine::Renderer::RenderTask tracktion::engine::CompGeneratorJob tracktion::engine::ProxyGeneratorJob tracktion::engine::AggregateJob tracktion::engine::EditRenderJob tracktion::engine::ReverseRenderJob tracktion::engine::TransientDetectionJob tracktion::engine::WarpTimeRenderJob

Public Member Functions

 ThreadPoolJobWithProgress (const juce::String &name)
 
virtual float getCurrentTaskProgress ()=0
 
virtual bool canCancel () const
 
void setManager (BackgroundJobManager &)
 
void setName (const juce::String &newName)
 Sets the job's name but also updates the manager so the list will reflect it.
 
void prepareForJobDeletion ()
 Call this in your sub-class destructor to to remvoe it from the manager queue before this class's destructor is called which can result in a pure virtual call.
 
- Public Member Functions inherited from juce::ThreadPoolJob
 ThreadPoolJob (const String &name)
 
String getJobName () const
 
void setJobName (const String &newName)
 
virtual JobStatus runJob ()=0
 
bool isRunning () const noexcept
 
bool shouldExit () const noexcept
 
void signalJobShouldExit ()
 
void addListener (Thread::Listener *)
 
void removeListener (Thread::Listener *)
 

Additional Inherited Members

- Public Types inherited from juce::ThreadPoolJob
enum  JobStatus
 
- Static Public Member Functions inherited from juce::ThreadPoolJob
static ThreadPoolJob * getCurrentThreadPoolJob ()
 
- Public Attributes inherited from juce::ThreadPoolJob
 jobHasFinished
 
 jobNeedsRunningAgain
 

Detailed Description

Definition at line 17 of file tracktion_BackgroundJobs.h.

Constructor & Destructor Documentation

◆ ThreadPoolJobWithProgress()

tracktion::engine::ThreadPoolJobWithProgress::ThreadPoolJobWithProgress ( const juce::String &  name)

Definition at line 20 of file tracktion_BackgroundJobs.h.

◆ ~ThreadPoolJobWithProgress()

tracktion::engine::ThreadPoolJobWithProgress::~ThreadPoolJobWithProgress ( )

Definition at line 220 of file tracktion_BackgroundJobs.h.

Member Function Documentation

◆ canCancel()

virtual bool tracktion::engine::ThreadPoolJobWithProgress::canCancel ( ) const
virtual

Definition at line 24 of file tracktion_BackgroundJobs.h.

◆ getCurrentTaskProgress()

virtual float tracktion::engine::ThreadPoolJobWithProgress::getCurrentTaskProgress ( )
pure virtual

Implemented in tracktion::engine::AudioClipBase::TempoDetectTask, and tracktion::engine::RenderManager::Job.

◆ prepareForJobDeletion()

void tracktion::engine::ThreadPoolJobWithProgress::prepareForJobDeletion ( )

Call this in your sub-class destructor to to remvoe it from the manager queue before this class's destructor is called which can result in a pure virtual call.

Definition at line 243 of file tracktion_BackgroundJobs.h.

◆ setManager()

void tracktion::engine::ThreadPoolJobWithProgress::setManager ( BackgroundJobManager &  m)

Definition at line 228 of file tracktion_BackgroundJobs.h.

◆ setName()

void tracktion::engine::ThreadPoolJobWithProgress::setName ( const juce::String &  newName)

Sets the job's name but also updates the manager so the list will reflect it.

Definition at line 235 of file tracktion_BackgroundJobs.h.

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