An effect is a simple processor that can modify an audio stream. An effect is guaranteed to the same number of inputs and outputs.

#include <effect.h>

Inheritance diagram for ape::Effect:

Protected Member Functions
	Effect ()

Protected Member Functions inherited from ape::Processor
	Processor ()

virtual void	processingHook ()
	Internal use only More...

void	setTriggeringChannel (int channel)
	Request the oscilloscope to trigger on a specific channel (default is the first output channel from the plugin). More...

void	defaultProcess (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
	Copy the number of shared channels from inputs to outputs , clearing any extra outputs in outputs . See also sharedChannels, clear() More...

virtual void	start (const IOConfig &config)
	Start processing with a certain configuration. Resources can be allocated here. More...

virtual void	stop ()
	Stop processing. Here's a good place to release any large resources. More...

virtual void	process (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
	Callback for processing a buffer switch in real-time. More...

Additional Inherited Members
Public Member Functions inherited from ape::Processor
void	init ()
	Called after every constructor in the inheritance chain has run More...

void	close ()
	Called just before any destructor is run. More...

void	processFrames (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
	Trigger processing of the inputs into the outputs . See also EmbeddedEffect::process, EmbeddedGenerator::process More...

virtual Status	onEvent (Event *e)
	Send an event to this processor. More...

virtual	~Processor ()
	Polymorphically destruct this processor More...

const IOConfig &	config () const
	Return the configuration this processor is initialized with. More...

std::size_t	sharedChannels () const noexcept
	Returns the minimum number of shared channels between inputs and outputs. More...

Detailed Description

An effect is a simple processor that can modify an audio stream. An effect is guaranteed to the same number of inputs and outputs.

Constructor & Destructor Documentation

ape::Effect::Effect ( )

inlineprotected

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