tracktion::engine::Renderer::RenderTask Class Reference

Task that actually performs the render operation in blocks. More...

Inheritance diagram for tracktion::engine::Renderer::RenderTask:

Public Member Functions
	RenderTask (const juce::String &taskDescription, const Renderer::Parameters &, std::atomic< float > *progressToUpdate, juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *)
	RenderTask (const juce::String &taskDescription, const Renderer::Parameters &, std::unique_ptr< tracktion::graph::Node >, std::unique_ptr< tracktion::graph::PlayHead >, std::unique_ptr< tracktion::graph::PlayHeadState >, std::unique_ptr< ProcessState >, std::atomic< float > *progressToUpdate, juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *)
	~RenderTask () override
JobStatus	runJob () override
float	getCurrentTaskProgress () override
bool	performNormalisingAndTrimming (const Renderer::Parameters &target, const Renderer::Parameters &intermediate)
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 void	flushAllPlugins (const Plugin::Array &, double sampleRate, int samplesPerBlock)
static void	setAllPluginsRealtime (const Plugin::Array &, bool realtime)
static bool	addMidiMetaDataAndWriteToFile (juce::File, juce::MidiMessageSequence, const TempoSequence &)

Public Attributes
Renderer::Parameters	params
juce::String	errorMessage

Detailed Description

Task that actually performs the render operation in blocks.

You should continually call the runJob method until it returns jobHasFinished.

Constructor & Destructor Documentation

RenderTask() [1/2]

tracktion::engine::Renderer::RenderTask::RenderTask	(	const juce::String &	taskDescription,
		const Renderer::Parameters &	,
		std::atomic< float > *	progressToUpdate,
		juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *
	)

RenderTask() [2/2]

tracktion::engine::Renderer::RenderTask::RenderTask	(	const juce::String &	taskDescription,
		const Renderer::Parameters &	,
		std::unique_ptr< tracktion::graph::Node >	,
		std::unique_ptr< tracktion::graph::PlayHead >	,
		std::unique_ptr< tracktion::graph::PlayHeadState >	,
		std::unique_ptr< ProcessState >	,
		std::atomic< float > *	progressToUpdate,
		juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *
	)

~RenderTask()

tracktion::engine::Renderer::RenderTask::~RenderTask ( )

override

Member Function Documentation

runJob()

JobStatus tracktion::engine::Renderer::RenderTask::runJob ( )

override

getCurrentTaskProgress()

float tracktion::engine::Renderer::RenderTask::getCurrentTaskProgress ( )

overridevirtual

Implements tracktion::engine::ThreadPoolJobWithProgress.

flushAllPlugins()

static void tracktion::engine::Renderer::RenderTask::flushAllPlugins ( const Plugin::Array &  , double  sampleRate, int  samplesPerBlock  )

static

setAllPluginsRealtime()

static void tracktion::engine::Renderer::RenderTask::setAllPluginsRealtime ( const Plugin::Array &  , bool  realtime  )

static

addMidiMetaDataAndWriteToFile()

static bool tracktion::engine::Renderer::RenderTask::addMidiMetaDataAndWriteToFile ( juce::File  , juce::MidiMessageSequence  , const TempoSequence &    )

static

performNormalisingAndTrimming()

bool tracktion::engine::Renderer::RenderTask::performNormalisingAndTrimming	(	const Renderer::Parameters &	target,
		const Renderer::Parameters &	intermediate
	)

Member Data Documentation

params

Renderer::Parameters tracktion::engine::Renderer::RenderTask::params

errorMessage

juce::String tracktion::engine::Renderer::RenderTask::errorMessage

---

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

• tracktion_Renderer.h