ape  0.5.0
Audio Programming Environment
Protected Member Functions | List of all members
ape::TransportEffect Class Reference

The same as Effect, except it also can query information about the playhead (TransportProcessor::getPlayHeadPosition(), as well as having play() and pause() callbacks. TransportProcessor for more information.

See also
GlobalData
More...

#include <effect.h>

Inheritance diagram for ape::TransportEffect:
ape::TransportProcessor ape::Processor ape::UIObject

Protected Member Functions

 TransportEffect ()
 
- Protected Member Functions inherited from ape::TransportProcessor
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_PlayHeadPositiongetPlayHeadPosition ()
 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...
 

Additional Inherited Members

- Public Member Functions inherited from ape::TransportProcessor
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 IOConfigconfig () 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

The same as Effect, except it also can query information about the playhead (TransportProcessor::getPlayHeadPosition(), as well as having play() and pause() callbacks. TransportProcessor for more information.

See also
GlobalData

Constructor & Destructor Documentation

◆ TransportEffect()

ape::TransportEffect::TransportEffect ( )
inlineprotected

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