Static Public Member Functions | |
| static Ptr | getOrCreateRenderJob (AudioClipBase &clip, const juce::File &source, const juce::File &destination) |
Protected Member Functions | |
| bool | setUpRender () override |
| Subclasses should override this to set-up their render process. More... | |
| bool | renderNextBlock () override |
| During a render process this will be repeatedly called. More... | |
| bool | completeRender () override |
| This is called once after all the render blocks have completed. More... | |
 Protected Member Functions inherited from tracktion::engine::RenderManager::Job | |
| Job (Engine &, const AudioFile &proxy) | |
Additional Inherited Members | |
| Public Types inherited from tracktion::engine::RenderManager::Job | |
| using | Ptr = juce::ReferenceCountedObjectPtr< Job > |
| Public Member Functions inherited from tracktion::engine::RenderManager::Job | |
| ~Job () override | |
| JobStatus | runJob () override |
| Performs the render. More... | |
| float | getCurrentTaskProgress () override |
| Returns the progress of the job. More... | |
| void | cancelJob () |
| Cancels the current job safely making sure any listeners are called appropriately. More... | |
| void | cleanUpDanglingJob () |
| Called during app shutdown by the manager on any jobs that haven't had a chance to recieve their async completion callbacks. More... | |
| void | incReferenceCount () noexcept |
| bool | decReferenceCountWithoutDeleting () noexcept |
| int | getReferenceCount () const noexcept |
| void | addListener (Listener *l) |
| void | removeListener (Listener *l) |
| Public Member Functions inherited from tracktion::engine::ThreadPoolJobWithProgress | |
| ThreadPoolJobWithProgress (const juce::String &name) | |
| ~ThreadPoolJobWithProgress () | |
| 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. More... | |
| 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. More... | |
| Public Attributes inherited from tracktion::engine::RenderManager::Job | |
| Engine & | engine |
| AudioFile | proxy |
| std::atomic< float > | progress { 0 } |
Member Function Documentation
◆ getOrCreateRenderJob()
|
static |
◆ setUpRender()
|
overrideprotectedvirtual |
Subclasses should override this to set-up their render process.
Return true if the set-up completed successfully and the rest of the render callbacks should be called, false if there was a problem and the render should be stopped.
Implements tracktion::engine::RenderManager::Job.
◆ renderNextBlock()
|
overrideprotectedvirtual |
During a render process this will be repeatedly called.
Return true once all the blocks have completed, false if this needs to be called again.
Implements tracktion::engine::RenderManager::Job.
References tracktion::engine::AudioFileInfo::bitsPerSample, CRASH_TRACER, tracktion::engine::RenderManager::Job::engine, tracktion::engine::Engine::getAudioFileFormatManager(), tracktion::engine::AudioFile::getFile(), tracktion::engine::AudioFile::getInfo(), tracktion::engine::AudioFileFormatManager::getWavFormat(), tracktion::engine::AudioFileWriter::isOpen(), tracktion::engine::AudioFileInfo::metadata, tracktion::engine::AudioFileInfo::numChannels, tracktion::engine::RenderManager::Job::progress, tracktion::engine::RenderManager::Job::proxy, and tracktion::engine::AudioFileInfo::sampleRate.
◆ completeRender()
|
overrideprotectedvirtual |
This is called once after all the render blocks have completed.
Subclasses should override this to finish off their render by closing files and etc. returning true if everything completed successfully, false otherwise.
Implements tracktion::engine::RenderManager::Job.
The documentation for this class was generated from the following file:
