A Processor with additional access to the transport / playhead of the host. More...

#include <processor.h>

Inheritance diagram for ape::TransportProcessor:

Public Member Functions
Status	onEvent (Event *e) override
	Send an event to this processor. More...

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	~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...

Protected Member Functions
virtual void	play ()
	Callback when the projects starts to "play". See also stop() More...

virtual void	pause ()
	Callback when the project stops playback. See also play() More...

const APE_PlayHeadPosition &	getPlayHeadPosition ()
	Returns current position info about the playhead. More...

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

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...

Detailed Description

A Processor with additional access to the transport / playhead of the host.

Member Function Documentation

const APE_PlayHeadPosition& ape::TransportProcessor::getPlayHeadPosition ( )

inlineprotected

Returns current position info about the playhead.

Only sensical when called from within a Processor::process() callback

Status ape::TransportProcessor::onEvent ( Event * e )

inlineoverridevirtual

Send an event to this processor.

Parameters

Event The polymorphic event to process.

Returns: Whether the event was handled (StatusCode::Handled) or not implemented (StatusCode::NotImplemented).

Reimplemented from ape::Processor.

virtual void ape::TransportProcessor::pause ( )

inlineprotectedvirtual

Callback when the project stops playback.

Called from the audio thread.

virtual void ape::TransportProcessor::play ( )

inlineprotectedvirtual

Callback when the projects starts to "play".

Called from the audio thread.

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