engine::Renderer::RenderTask Class Reference

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

#include <tracktion_Renderer.h>

Inherits ThreadPoolJobWithProgress.

Public Member Functions
	RenderTask (const juce::String &taskDescription, const Renderer::Parameters &, std::atomic< float > *progressToUpdate, juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *)
	Constructs a RenderTask for a set of parameters.
	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 *)
	Constructs a RenderTask for a set of parameters and existing graph.
	~RenderTask () override
	Destructor.
JobStatus	runJob () override
	Call until this returns jobHasFinished to perform the render.
float	getCurrentTaskProgress () override
	Returns the current progress of the render.
bool	performNormalisingAndTrimming (const Renderer::Parameters &target, const Renderer::Parameters &intermediate)

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
	The Parameters being used.
juce::String	errorMessage
	An error message if the render failed to start.

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]

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

Constructs a RenderTask for a set of parameters.

RenderTask() [2/2]

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 *
	)

Constructs a RenderTask for a set of parameters and existing graph.

~RenderTask()

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

override

Destructor.

Member Function Documentation

runJob()

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

override

Call until this returns jobHasFinished to perform the render.

getCurrentTaskProgress()

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

override

Returns the current progress of the render.

flushAllPlugins()

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

static

setAllPluginsRealtime()

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

static

addMidiMetaDataAndWriteToFile()

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

static

performNormalisingAndTrimming()

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

Member Data Documentation

params

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

The Parameters being used.

errorMessage

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

An error message if the render failed to start.

---

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

• tracktion_Renderer.h