ape  0.5.0
Audio Programming Environment
Public Member Functions | List of all members
ape::EmbeddedEffect< TEffect > Class Template Referencefinal

A utility class to embed another Effect inside your own. It takes care of initialization. More...

#include <effect.h>

Inheritance diagram for ape::EmbeddedEffect< TEffect >:
ape::EmbeddedProcessor< TEffect >

Public Member Functions

void process (umatrix< const float > inputs, umatrix< float > outputs, size_t frames)
 Call this to invoke the embedded effect's processor routine. More...
 
- Public Member Functions inherited from ape::EmbeddedProcessor< TEffect >
 EmbeddedProcessor ()
 Initializes the processor. Processor::init() More...
 
 ~EmbeddedProcessor ()
 Initializes the processor. Processor::init() More...
 
void start (const IOConfig &cfg)
 Starts the processor with a specific configuration. Processor::start() More...
 
void stop ()
 Stops the processor. Processor::stop() More...
 
TEffect * operator-> ()
 Access the wrapped TProcessor instance. More...
 

Additional Inherited Members

- Protected Attributes inherited from ape::EmbeddedProcessor< TEffect >
TEffect processor
 

Detailed Description

template<class TEffect>
class ape::EmbeddedEffect< TEffect >

A utility class to embed another Effect inside your own. It takes care of initialization.

Take care to call EmbeddedProcessor<TEffect>::start() on any embedded plugins.

Member Function Documentation

◆ process()

template<class TEffect >
void ape::EmbeddedEffect< TEffect >::process ( umatrix< const float >  inputs,
umatrix< float >  outputs,
size_t  frames 
)
inline

Call this to invoke the embedded effect's processor routine.


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