engine::Renderer Class Reference

Lowest level render operation. More...

#include <tracktion_Renderer.h>

Classes
struct	Parameters
	Holds all the properties of a single render operation. More...
struct	RenderResult
class	RenderTask
	Task that actually performs the render operation in blocks. More...
struct	ScopedClipSlotDisabler
	Temporarily disables clip slots. Useful for rendering/freezing tracks. More...
struct	Statistics

Static Public Member Functions
static void	checkTargetFile (Engine &, const juce::File &, std::function< void(bool)> callback)
	Cheks a file for write access etc.
static void	turnOffAllPlugins (Edit &)
	Deinitialises all the plugins for the Edit.
static ProjectItem::Ptr	renderToProjectItem (const juce::String &taskDescription, const Parameters &, ProjectItem::Category)
	Blocking render operations.
static juce::File	renderToFile (const juce::String &taskDescription, const Parameters &)
	Renders an Edit to a file given by the Parameters.
static bool	renderToFile (const juce::String &taskDescription, const juce::File &outputFile, Edit &edit, TimeRange range, const juce::BigInteger &tracksToDo, bool usePlugins=true, bool useACID=true, juce::Array< Clip * > clips={}, bool useThread=true)
	Renders an Edit to a file within the given time range and the track indicies described by the BigInteger.
static bool	renderToFile (Edit &, const juce::File &, bool useThread=true)
	Renders an entire Edit to a file.
static Statistics	measureStatistics (const juce::String &taskDescription, Edit &edit, TimeRange range, const juce::BigInteger &tracksToDo, int blockSizeForAudio, double sampleRateForAudio=44100.0)
	Renders a section of an edit to measure various details about its audio content.

Detailed Description

Lowest level render operation.

This can be used when you want complete control over a render operation.

Member Function Documentation

checkTargetFile()

static void engine::Renderer::checkTargetFile ( Engine &  , const juce::File &  , std::function< void(bool)>  callback  )

static

Cheks a file for write access etc.

and presents pop-up options to the user if problems occur.

turnOffAllPlugins()

static void engine::Renderer::turnOffAllPlugins ( Edit &  )

static

Deinitialises all the plugins for the Edit.

renderToProjectItem()

static ProjectItem::Ptr engine::Renderer::renderToProjectItem ( const juce::String &  taskDescription, const Parameters &  , ProjectItem::Category    )

static

Blocking render operations.

See also

EditRenderer below for async render operations Renders an Edit to a file and creates a new ProjectItem for it.

renderToFile() [1/3]

static juce::File engine::Renderer::renderToFile ( const juce::String &  taskDescription, const Parameters &    )

static

Renders an Edit to a file given by the Parameters.

renderToFile() [2/3]

static bool engine::Renderer::renderToFile ( const juce::String &  taskDescription, const juce::File &  outputFile, Edit &  edit, TimeRange  range, const juce::BigInteger &  tracksToDo, bool  usePlugins = true, bool  useACID = true, juce::Array< Clip * >  clips = {}, bool  useThread = true  )

static

Renders an Edit to a file within the given time range and the track indicies described by the BigInteger.

renderToFile() [3/3]

static bool engine::Renderer::renderToFile ( Edit &  , const juce::File &  , bool  useThread = true  )

static

Renders an entire Edit to a file.

measureStatistics()

static Statistics engine::Renderer::measureStatistics ( const juce::String &  taskDescription, Edit &  edit, TimeRange  range, const juce::BigInteger &  tracksToDo, int  blockSizeForAudio, double  sampleRateForAudio = 44100.0  )

static

Renders a section of an edit to measure various details about its audio content.

---

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

• tracktion_Renderer.h