quantumVERB  1.0.0
A FOSS convolution reverb plugin
reverb::Gain Class Reference

#include <Gain.h>

Inheritance diagram for reverb::Gain:
Collaboration diagram for reverb::Gain:

Public Types

using Ptr = std::shared_ptr< Gain >
 
- Public Types inherited from reverb::Task
using Ptr = std::shared_ptr< Task >
 

Public Member Functions

 Gain (juce::AudioProcessor *processor)
 Constructor. Creates a Gain object. More...
 
virtual void updateParams (const juce::AudioProcessorValueTreeState &params, const juce::String &blockId) override
 Updates parameters from processor parameter tree. More...
 
virtual AudioBlock exec (AudioBlock buffer) override
 Apply Gain to input buffer to change volume of signal audio. More...
 
- Public Member Functions inherited from reverb::Task
 Task (juce::AudioProcessor *processor)
 
virtual bool needsToRun () const
 Tells caller whether block must be run for current block. More...
 
virtual void updateSampleRate (double sr)
 Update sample rate for task block. More...
 

Protected Attributes

float gainFactor = 1.0f
 
- Protected Attributes inherited from reverb::Task
juce::AudioProcessor * processor
 
bool mustExec = true
 

Additional Inherited Members

- Public Attributes inherited from reverb::Task
double sampleRate
 
- Protected Member Functions inherited from reverb::Task
float getParam (const juce::AudioProcessorValueTreeState &params, const juce::String &blockId) const
 Internal method used to get (and check) a parameter's value.
 

Detailed Description

TODO: Description

Definition at line 20 of file Gain.h.

Constructor & Destructor Documentation

◆ Gain()

reverb::Gain::Gain ( juce::AudioProcessor *  processor)

Constructor. Creates a Gain object.

Creates a Gain object associated to an AudioProcessor.

Parameters
[in]processorPointer to main processor

Definition at line 24 of file Gain.cpp.

Member Function Documentation

◆ exec()

AudioBlock reverb::Gain::exec ( AudioBlock  buffer)
overridevirtual

Apply Gain to input buffer to change volume of signal audio.

Gain to apply to audio buffer is stocked in gainFactor

Parameters
[in,out]bufferAudio sample buffer to process

Implements reverb::Task.

Definition at line 55 of file Gain.cpp.

◆ updateParams()

void reverb::Gain::updateParams ( const juce::AudioProcessorValueTreeState &  params,
const juce::String &  blockId 
)
overridevirtual

Updates parameters from processor parameter tree.

Parameters
[in]paramsProcessor parameter tree
[in]blockIdID of block whose paramters should be checked

Implements reverb::Task.

Definition at line 35 of file Gain.cpp.


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