tracktion::engine::RenderManager Class Reference

Manages a set of reference counted render jobs and can be used to retrieve matching jobs or create new ones. More...

#include "tracktion_RenderManager.h"

Inheritance diagram for tracktion::engine::RenderManager:

Classes
class	Job
	The base class that all generator jobs derive from. More...

Public Member Functions
	RenderManager (Engine &)
void	cleanUp ()
	Cleans up any remaining jobs - should be called before the manager is deleted.
Job::Ptr	getRenderJobWithoutCreating (const AudioFile &audioFile)
	This will return a Ptr to an existing render job for an audio file or nullptr if no job is in progress.
juce::ReferenceCountedArray< Job >	getRenderJobsWithoutCreating (const AudioFile &)
	Returns all the jobs that may be processing the given file.
int	getNumJobs () noexcept
	Returns the number of jobs in the pool.
bool	isProxyBeingGenerated (const AudioFile &proxyFile) noexcept
	Returns true if a render is currently being performed for this AudioFile.
float	getProportionComplete (const AudioFile &proxyFile, float defaultVal) noexcept
	Returns true if a render is currently being performed for this AudioFile.

Static Public Member Functions
static AudioFile	getAudioFileForHash (Engine &, const juce::File &directory, HashCode hash)
	Returns the AudioFile for a particular hash.
static juce::StringRef	getFileRenderPrefix ()
	Returns the prefix used for render files.

Public Attributes
Engine &	engine

Detailed Description

Manages a set of reference counted render jobs and can be used to retrieve matching jobs or create new ones.

Definition at line 19 of file tracktion_RenderManager.h.

Constructor & Destructor Documentation

RenderManager()

tracktion::engine::RenderManager::RenderManager

(

Engine &

e

)

Definition at line 164 of file tracktion_RenderManager.cpp.

~RenderManager()

tracktion::engine::RenderManager::~RenderManager ( )

override

Definition at line 168 of file tracktion_RenderManager.cpp.

Member Function Documentation

cleanUp()

void tracktion::engine::RenderManager::cleanUp

(

)

Cleans up any remaining jobs - should be called before the manager is deleted.

Definition at line 175 of file tracktion_RenderManager.cpp.

getAudioFileForHash()

AudioFile tracktion::engine::RenderManager::getAudioFileForHash ( Engine &  engine, const juce::File &  directory, HashCode  hash  )

static

Returns the AudioFile for a particular hash.

If this is not valid you should then start a new job using getOrCreateRenderJob. You should always check this first, never start a new job unnecessarily.

Definition at line 194 of file tracktion_RenderManager.cpp.

getFileRenderPrefix()

static juce::StringRef tracktion::engine::RenderManager::getFileRenderPrefix ( )

static

Returns the prefix used for render files.

Definition at line 165 of file tracktion_RenderManager.h.

getNumJobs()

int tracktion::engine::RenderManager::getNumJobs ( )

noexcept

Returns the number of jobs in the pool.

Definition at line 212 of file tracktion_RenderManager.cpp.

getProportionComplete()

float tracktion::engine::RenderManager::getProportionComplete ( const AudioFile &  proxyFile, float  defaultVal  )

noexcept

Returns true if a render is currently being performed for this AudioFile.

Definition at line 224 of file tracktion_RenderManager.cpp.

getRenderJobsWithoutCreating()

juce::ReferenceCountedArray< RenderManager::Job > tracktion::engine::RenderManager::getRenderJobsWithoutCreating

(

const AudioFile &

af

)

Returns all the jobs that may be processing the given file.

Definition at line 199 of file tracktion_RenderManager.cpp.

getRenderJobWithoutCreating()

Job::Ptr tracktion::engine::RenderManager::getRenderJobWithoutCreating

(

const AudioFile &

audioFile

)

This will return a Ptr to an existing render job for an audio file or nullptr if no job is in progress.

Definition at line 155 of file tracktion_RenderManager.h.

isProxyBeingGenerated()

bool tracktion::engine::RenderManager::isProxyBeingGenerated ( const AudioFile &  proxyFile )

noexcept

Returns true if a render is currently being performed for this AudioFile.

Definition at line 219 of file tracktion_RenderManager.cpp.

Member Data Documentation

engine

Engine& tracktion::engine::RenderManager::engine

Definition at line 173 of file tracktion_RenderManager.h.

---

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

• tracktion_engine/model/export/tracktion_RenderManager.h
• tracktion_engine/model/export/tracktion_RenderManager.cpp