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::AudioClipBase::TempoDetectTask Class Reference

Performs a tempo detection task on a background thread. More...

Inheritance diagram for tracktion::engine::AudioClipBase::TempoDetectTask:
tracktion::engine::ThreadPoolJobWithProgress juce::ThreadPoolJob

Public Member Functions

 TempoDetectTask (Engine &e, const juce::File &file)
 Creates a task for a given file.
 
float getBpm ()
 Returns the bpm after a successful detection.
 
bool isResultSensible ()
 Returns true if the result was within a sensible range.
 
JobStatus runJob () override
 Performs the actual detection.
 
float getCurrentTaskProgress () override
 Returns the current progress.
 
- 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 *)
 

Additional Inherited Members

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

Detailed Description

Performs a tempo detection task on a background thread.

Definition at line 18 of file tracktion_AudioClipBase.cpp.

Constructor & Destructor Documentation

◆ TempoDetectTask()

tracktion::engine::AudioClipBase::TempoDetectTask::TempoDetectTask ( Engine e,
const juce::File file 
)

Creates a task for a given file.

Definition at line 22 of file tracktion_AudioClipBase.cpp.

Member Function Documentation

◆ getBpm()

float tracktion::engine::AudioClipBase::TempoDetectTask::getBpm ( )

Returns the bpm after a successful detection.

Definition at line 29 of file tracktion_AudioClipBase.cpp.

◆ getCurrentTaskProgress()

float tracktion::engine::AudioClipBase::TempoDetectTask::getCurrentTaskProgress ( )
overridevirtual

Returns the current progress.

Implements tracktion::engine::ThreadPoolJobWithProgress.

Definition at line 84 of file tracktion_AudioClipBase.cpp.

◆ isResultSensible()

bool tracktion::engine::AudioClipBase::TempoDetectTask::isResultSensible ( )

Returns true if the result was within a sensible range.

Definition at line 32 of file tracktion_AudioClipBase.cpp.

◆ runJob()

JobStatus tracktion::engine::AudioClipBase::TempoDetectTask::runJob ( )
overridevirtual

Performs the actual detection.

Implements juce::ThreadPoolJob.

Definition at line 36 of file tracktion_AudioClipBase.cpp.


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