CLAM::EnvelopeModulator Class Reference
#include <EnvelopeModulator.hxx>
Inheritance diagram for CLAM::EnvelopeModulator:
Detailed Description
Definition at line 47 of file EnvelopeModulator.hxx.
Public Member Functions | |
| EnvelopeModulator (const EnvModulatorConfig &c=EnvModulatorConfig()) | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| void | Attach (Envelope &env, Audio &inp, Audio &out) |
| bool | Do (void) |
| Supervised mode execution method (using ports). | |
| bool | Do (const Envelope &env, const Audio &inp, Audio &out) |
Public Attributes | |
| InPort< Envelope > | InputEnvelope |
| InPort< Audio > | InputAudio |
| OutPort< Audio > | Output |
Constructor & Destructor Documentation
| CLAM::EnvelopeModulator::EnvelopeModulator | ( | const EnvModulatorConfig & | c = EnvModulatorConfig() |
) |
Member Function Documentation
| const char* CLAM::EnvelopeModulator::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 67 of file EnvelopeModulator.hxx.
| const ProcessingConfig& CLAM::EnvelopeModulator::GetConfig | ( | ) | const [inline, virtual] |
Configuration getter.
Gets the configuration parameters used to create the object.
- Returns:
- Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.
Reimplemented from CLAM::Processing.
Definition at line 69 of file EnvelopeModulator.hxx.
| bool CLAM::EnvelopeModulator::Do | ( | void | ) | [virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 68 of file EnvelopeModulator.cxx.
References InputAudio, InputEnvelope, and Output.
Definition at line 79 of file EnvelopeModulator.cxx.
References CLAM::Audio::GetSize(), and CLAM::BPFTmpl< TX, TY >::GetValue().
Member Data Documentation
The documentation for this class was generated from the following files:
