engine::PluginNode Class Reference

Node for processing a plugin. More...

#include <tracktion_PluginNode.h>

Inheritance diagram for engine::PluginNode:

Public Member Functions
	PluginNode (std::unique_ptr< Node > input, tracktion::engine::Plugin::Ptr, double sampleRateToUse, int blockSizeToUse, const TrackMuteState *, ProcessState &, bool rendering, bool balanceLatency, int maxNumChannelsToUse)
	Creates a PluginNode to process a plugin on a Track.
	~PluginNode () override
	Destructor.
Plugin &	getPlugin ()
tracktion::graph::NodeProperties	getNodeProperties () override
std::vector< Node * >	getDirectInputNodes () override
bool	isReadyToProcess () override
void	prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo &) override
void	prefetchBlock (juce::Range< int64_t >) override
void	preProcess (choc::buffer::FrameCount, juce::Range< int64_t >) override
void	process (ProcessContext &) override
Public Member Functions inherited from engine::TracktionEngineNode
	TracktionEngineNode (ProcessState &)
	Creates a TracktionEngineNode.
virtual	~TracktionEngineNode ()=default
	Destructor.
int	getNumSamples () const
	Returns the number of samples in the current process block.
double	getSampleRate () const
	Returns the sample rate of the current process block.
juce::Range< int64_t >	getTimelineSampleRange () const
	Returns the timeline sample range of the current process block.
TimeRange	getEditTimeRange () const
	Returns the edit time range of the current process block.
BeatRange	getEditBeatRange () const
	Returns the edit beat range of the current process block.
juce::Range< int64_t >	getReferenceSampleRange () const
	Returns the reference sample range (from the DeviceManager) of the current process block.
tempo::Key	getKey () const
	Returns the key of the current process block.
double	getPlaybackSpeedRatio () const
	Returns the playback speed ratio of the current process block.
std::optional< TimePosition >	getTimeOfNextChange () const
	May return the time of the next tempo or time sig change.
std::optional< BeatPosition >	getBeatOfNextChange () const
	May return the time of the next tempo or time sig change.
tracktion::graph::PlayHeadState &	getPlayHeadState ()
	Returns the PlayHeadState in use.
tracktion::graph::PlayHead &	getPlayHead ()
	Returns the PlayHead in use.
ProcessState &	getProcessState ()
	Returns the ProcessState in use.
void	setProcessState (ProcessState &)

Detailed Description

Node for processing a plugin.

Constructor & Destructor Documentation

PluginNode()

engine::PluginNode::PluginNode	(	std::unique_ptr< Node >	input,
		tracktion::engine::Plugin::Ptr	,
		double	sampleRateToUse,
		int	blockSizeToUse,
		const TrackMuteState *	,
		ProcessState &	,
		bool	rendering,
		bool	balanceLatency,
		int	maxNumChannelsToUse
	)

Creates a PluginNode to process a plugin on a Track.

Parameters

const	TrackMuteState* The optional TrackMuteState to use
ProcessState	The ProcessState for playhead access and time mapping
rendering	Should be true if this is an offline render
balanceLatency	If set to true, this creates a copy of the dry input and delays it by the plugin's latency and uses this when the plugin is bypassed to avoid changes in latency
maxNumChannelsToUse	Limits the maximum number of channels to use, set this to -1 to disable limitations

~PluginNode()

engine::PluginNode::~PluginNode ( )

override

Destructor.

Member Function Documentation

getPlugin()

Plugin & engine::PluginNode::getPlugin

(

)

getNodeProperties()

tracktion::graph::NodeProperties engine::PluginNode::getNodeProperties ( )

override

getDirectInputNodes()

std::vector< Node * > engine::PluginNode::getDirectInputNodes ( )

override

isReadyToProcess()

bool engine::PluginNode::isReadyToProcess ( )

override

prepareToPlay()

void engine::PluginNode::prepareToPlay ( const tracktion::graph::PlaybackInitialisationInfo &  )

override

prefetchBlock()

void engine::PluginNode::prefetchBlock ( juce::Range< int64_t >  )

override

preProcess()

void engine::PluginNode::preProcess ( choc::buffer::FrameCount  , juce::Range< int64_t >    )

override

process()

void engine::PluginNode::process ( ProcessContext &  )

override

---

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

• tracktion_PluginNode.h