tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
tracktion::engine::ExtractionTask Class Reference
Inheritance diagram for tracktion::engine::ExtractionTask:
tracktion::engine::ThreadPoolJobWithProgress juce::ThreadPoolJob

Public Member Functions

 ExtractionTask (TracktionArchiveFile &archive_, const juce::File &destDir_, bool warnAboutOverwrite_, juce::Array< juce::File > &filesCreated_, bool &wasAborted_)
 
JobStatus runJob ()
 
float getCurrentTaskProgress ()
 
- Public Member Functions inherited from tracktion::engine::ThreadPoolJobWithProgress
 ThreadPoolJobWithProgress (const juce::String &name)
 
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)
 
bool isRunning () const noexcept
 
bool shouldExit () const noexcept
 
void signalJobShouldExit ()
 
void addListener (Thread::Listener *)
 
void removeListener (Thread::Listener *)
 

Public Attributes

TracktionArchiveFilearchive
 
juce::File destDir
 
bool ok
 
bool & wasAborted
 
float progress
 
bool warnAboutOverwrite
 
juce::Array< juce::File > & filesCreated
 
- Public Attributes inherited from juce::ThreadPoolJob
 jobHasFinished
 
 jobNeedsRunningAgain
 

Additional Inherited Members

- Public Types inherited from juce::ThreadPoolJob
enum  JobStatus
 
- Static Public Member Functions inherited from juce::ThreadPoolJob
static ThreadPoolJobgetCurrentThreadPoolJob ()
 

Detailed Description

Definition at line 260 of file tracktion_ArchiveFile.cpp.

Constructor & Destructor Documentation

◆ ExtractionTask()

tracktion::engine::ExtractionTask::ExtractionTask ( TracktionArchiveFile archive_,
const juce::File destDir_,
bool  warnAboutOverwrite_,
juce::Array< juce::File > &  filesCreated_,
bool &  wasAborted_ 
)

Definition at line 263 of file tracktion_ArchiveFile.cpp.

Member Function Documentation

◆ getCurrentTaskProgress()

float tracktion::engine::ExtractionTask::getCurrentTaskProgress ( )
virtual

◆ runJob()

JobStatus tracktion::engine::ExtractionTask::runJob ( )
virtual

Implements juce::ThreadPoolJob.

Definition at line 276 of file tracktion_ArchiveFile.cpp.

Member Data Documentation

◆ archive

TracktionArchiveFile& tracktion::engine::ExtractionTask::archive

Definition at line 316 of file tracktion_ArchiveFile.cpp.

◆ destDir

juce::File tracktion::engine::ExtractionTask::destDir

Definition at line 317 of file tracktion_ArchiveFile.cpp.

◆ filesCreated

juce::Array<juce::File>& tracktion::engine::ExtractionTask::filesCreated

Definition at line 322 of file tracktion_ArchiveFile.cpp.

◆ ok

bool tracktion::engine::ExtractionTask::ok

Definition at line 318 of file tracktion_ArchiveFile.cpp.

◆ progress

float tracktion::engine::ExtractionTask::progress

Definition at line 320 of file tracktion_ArchiveFile.cpp.

◆ warnAboutOverwrite

bool tracktion::engine::ExtractionTask::warnAboutOverwrite

Definition at line 321 of file tracktion_ArchiveFile.cpp.

◆ wasAborted

bool& tracktion::engine::ExtractionTask::wasAborted

Definition at line 319 of file tracktion_ArchiveFile.cpp.


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