Public Member Functions | |
| ~EditRenderJob () override | |
| Destructor. More... | |
| const Renderer::Parameters & | getParams () const noexcept |
| Returns the parameters in use for this job. More... | |
| juce::AudioThumbnail & | getAudioThumbnail () |
| Returns an audio thumbnail that will be updated with the progress of the render operation. More... | |
| bool | isMidi () const noexcept |
| Returns true if this job is rendering MIDI. More... | |
| Renderer::RenderResult & | getResult () |
| Returns the result of this render. More... | |
| juce::String | getLastError () const |
 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... | |
Static Public Member Functions | |
| static Ptr | getOrCreateRenderJob (Engine &, Renderer::Parameters &, bool deleteEdit, bool silenceOnBackup, bool reverse) |
| Returns a job that will have been started to generate the Render described by the params. More... | |
| static Ptr | getOrCreateRenderJob (Engine &, const AudioFile &destFile, const RenderOptions &, ProjectItemID itemID, bool silenceOnBackup, bool reverse) |
| Creates a job based on a set of RenderOptions properties and a source Edit ProjectItemID. More... | |
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... | |
| void | setLastError (const juce::String &) |
| 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 Attributes inherited from tracktion::engine::RenderManager::Job | |
| Engine & | engine |
| AudioFile | proxy |
| std::atomic< float > | progress { 0 } |
Constructor & Destructor Documentation
◆ ~EditRenderJob()
|
override |
Destructor.
Member Function Documentation
◆ getOrCreateRenderJob() [1/2]
|
static |
Returns a job that will have been started to generate the Render described by the params.
To be notified of when the job completes add yourself as a listener. If the deleteEdit argument is true this will delete the Edit once it is done with it. The destFile should be the same as the params.destFile argument and is only provided so the file doesn't get deleted before creation. This job will continue to run until all references to it are deleted. Once this happens the render will be abandoned. If you delete yourself, make sure to unregister as a listener too.
◆ getOrCreateRenderJob() [2/2]
|
static |
Creates a job based on a set of RenderOptions properties and a source Edit ProjectItemID.
If this method is used the Edit will be created on the background render thread and be owned by the job.
◆ getParams()
|
noexcept |
Returns the parameters in use for this job.
◆ getAudioThumbnail()
| juce::AudioThumbnail& tracktion::engine::EditRenderJob::getAudioThumbnail | ( | ) |
Returns an audio thumbnail that will be updated with the progress of the render operation.
Don't hang onto this however as it is owned by the job and you should create your own thumbnail from the file once the job has finished.
◆ isMidi()
|
noexcept |
Returns true if this job is rendering MIDI.
This can be used to determine if the AudioThumbnail should be used to generate a thumbnail or some other means.
References tracktion::engine::Renderer::Parameters::createMidiFile.
◆ getResult()
| Renderer::RenderResult& tracktion::engine::EditRenderJob::getResult | ( | ) |
Returns the result of this render.
Only valid once the job has completed.
◆ getLastError()
| juce::String tracktion::engine::EditRenderJob::getLastError | ( | ) | const |
◆ 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.
◆ 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.
◆ setLastError()
|
protected |
The documentation for this class was generated from the following file:
