engine::WaveNode Class Reference

An Node that plays back a wave file. More...

#include <tracktion_WaveNode.h>

Inheritance diagram for engine::WaveNode:

Public Member Functions
	WaveNode (const AudioFile &, TimeRange editTime, TimeDuration offset, TimeRange loopSection, LiveClipLevel, double speedRatio, const ChannelConfiguration &sourceChannelsToUse, const ChannelConfiguration &destChannelsToFill, ProcessState &, EditItemID, bool isOfflineRender, std::shared_ptr< AudioClipPlayhead >={})
	offset is a time added to the start of the file, e.g.
tracktion::graph::NodeProperties	getNodeProperties () override
void	prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo &) override
bool	isReadyToProcess () 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

An Node that plays back a wave file.

Constructor & Destructor Documentation

WaveNode()

engine::WaveNode::WaveNode	(	const AudioFile &	,
		TimeRange	editTime,
		TimeDuration	offset,
		TimeRange	loopSection,
		LiveClipLevel	,
		double	speedRatio,
		const ChannelConfiguration &	sourceChannelsToUse,
		const ChannelConfiguration &	destChannelsToFill,
		ProcessState &	,
		EditItemID	,
		bool	isOfflineRender,
		std::shared_ptr< AudioClipPlayhead >	= {}
	)

offset is a time added to the start of the file, e.g.

an offset of 10.0 would produce ten seconds of silence followed by the file.

gain may be 0, or a pointer to a floating point value which is referred to as the gain to use when converting the file contents to floating point. e.g. gain of 2.0f will double the values returned.

Member Function Documentation

getNodeProperties()

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

override

prepareToPlay()

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

override

isReadyToProcess()

bool engine::WaveNode::isReadyToProcess ( )

override

process()

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

override

---

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

• tracktion_WaveNode.h