tracktion::engine::TracktionNodePlayer Class Reference

Plays back a Node with PlayHeadState and ProcessState. More...

#include "tracktion_TracktionNodePlayer.h"

Public Member Functions
	TracktionNodePlayer (ProcessState &processStateToUse)
	Creates an NodePlayer to process a Node.
	TracktionNodePlayer (ProcessState &processStateToUse, tracktion::graph::LockFreeMultiThreadedNodePlayer::ThreadPoolCreator poolCreator, juce::AudioWorkgroup audioWorkgroup={})
	Creates an NodePlayer to process a Node.
	TracktionNodePlayer (std::unique_ptr< tracktion::graph::Node > node, ProcessState &processStateToUse, double sampleRate, int blockSize, tracktion::graph::LockFreeMultiThreadedNodePlayer::ThreadPoolCreator poolCreator)
	Creates an NodePlayer to process a Node.
void	setNumThreads (size_t numThreads)
	Sets the number of threads to use for rendering.
tracktion::graph::Node *	getNode ()
void	setNode (std::unique_ptr< tracktion::graph::Node > newNode)
void	setNode (std::unique_ptr< tracktion::graph::Node > newNode, double sampleRateToUse, int blockSizeToUse)
void	prepareToPlay (double sampleRateToUse, int blockSizeToUse)
int	process (const tracktion::graph::Node::ProcessContext &pc)
	Processes a block of audio and MIDI data.
void	clearNode ()
	Clears the Node currently playing.
double	getSampleRate () const
	Returns the current sample rate.
void	enablePooledMemoryAllocations (bool enablePooledMemory)
void	enableNodeMemorySharing (bool enableNodeMemorySharing)

Detailed Description

Plays back a Node with PlayHeadState and ProcessState.

Definition at line 22 of file tracktion_TracktionNodePlayer.h.

Constructor & Destructor Documentation

TracktionNodePlayer() [1/3]

tracktion::engine::TracktionNodePlayer::TracktionNodePlayer

(

ProcessState &

processStateToUse

)

Creates an NodePlayer to process a Node.

Definition at line 26 of file tracktion_TracktionNodePlayer.h.

TracktionNodePlayer() [2/3]

tracktion::engine::TracktionNodePlayer::TracktionNodePlayer	(	ProcessState &	processStateToUse,
		tracktion::graph::LockFreeMultiThreadedNodePlayer::ThreadPoolCreator	poolCreator,
		juce::AudioWorkgroup	audioWorkgroup = {}
	)

Creates an NodePlayer to process a Node.

Definition at line 33 of file tracktion_TracktionNodePlayer.h.

TracktionNodePlayer() [3/3]

tracktion::engine::TracktionNodePlayer::TracktionNodePlayer	(	std::unique_ptr< tracktion::graph::Node >	node,
		ProcessState &	processStateToUse,
		double	sampleRate,
		int	blockSize,
		tracktion::graph::LockFreeMultiThreadedNodePlayer::ThreadPoolCreator	poolCreator
	)

Creates an NodePlayer to process a Node.

Definition at line 43 of file tracktion_TracktionNodePlayer.h.

Member Function Documentation

clearNode()

void tracktion::engine::TracktionNodePlayer::clearNode

(

)

Clears the Node currently playing.

Definition at line 108 of file tracktion_TracktionNodePlayer.h.

enableNodeMemorySharing()

void tracktion::engine::TracktionNodePlayer::enableNodeMemorySharing

(

bool

enableNodeMemorySharing

)

Definition at line 126 of file tracktion_TracktionNodePlayer.h.

enablePooledMemoryAllocations()

void tracktion::engine::TracktionNodePlayer::enablePooledMemoryAllocations

(

bool

enablePooledMemory

)

Definition at line 120 of file tracktion_TracktionNodePlayer.h.

getNode()

tracktion::graph::Node * tracktion::engine::TracktionNodePlayer::getNode

(

)

Definition at line 61 of file tracktion_TracktionNodePlayer.h.

getSampleRate()

double tracktion::engine::TracktionNodePlayer::getSampleRate

(

)

const

Returns the current sample rate.

Definition at line 114 of file tracktion_TracktionNodePlayer.h.

prepareToPlay()

void tracktion::engine::TracktionNodePlayer::prepareToPlay	(	double	sampleRateToUse,
		int	blockSizeToUse
	)

Definition at line 76 of file tracktion_TracktionNodePlayer.h.

process()

int tracktion::engine::TracktionNodePlayer::process

(

const tracktion::graph::Node::ProcessContext &

pc

)

Processes a block of audio and MIDI data.

Returns the number of times a node was checked but unable to be processed.

Definition at line 84 of file tracktion_TracktionNodePlayer.h.

setNode() [1/2]

void tracktion::engine::TracktionNodePlayer::setNode

(

std::unique_ptr< tracktion::graph::Node >

newNode

)

Definition at line 66 of file tracktion_TracktionNodePlayer.h.

setNode() [2/2]

void tracktion::engine::TracktionNodePlayer::setNode	(	std::unique_ptr< tracktion::graph::Node >	newNode,
		double	sampleRateToUse,
		int	blockSizeToUse
	)

Definition at line 71 of file tracktion_TracktionNodePlayer.h.

setNumThreads()

void tracktion::engine::TracktionNodePlayer::setNumThreads

(

size_t

numThreads

)

Sets the number of threads to use for rendering.

This can be 0 in which case only the process calling thread will be used for processing. N.B. this will pause processing whilst updating the threads so there will be a gap in the audio.

Definition at line 56 of file tracktion_TracktionNodePlayer.h.

---

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

• tracktion_engine/playback/graph/tracktion_TracktionNodePlayer.h