A very simple ADSR envelope class.
More...
#include <juce_ADSR.h>
|
| ADSR () |
|
void | setParameters (const Parameters &newParameters) |
| Sets the parameters that will be used by an ADSR object.
|
|
const Parameters & | getParameters () const noexcept |
| Returns the parameters currently being used by an ADSR object.
|
|
bool | isActive () const noexcept |
| Returns true if the envelope is in its attack, decay, sustain or release stage.
|
|
void | setSampleRate (double newSampleRate) noexcept |
| Sets the sample rate that will be used for the envelope.
|
|
void | reset () noexcept |
| Resets the envelope to an idle state.
|
|
void | noteOn () noexcept |
| Starts the attack phase of the envelope.
|
|
void | noteOff () noexcept |
| Starts the release phase of the envelope.
|
|
float | getNextSample () noexcept |
| Returns the next sample value for an ADSR object.
|
|
template<typename FloatType > |
void | applyEnvelopeToBuffer (AudioBuffer< FloatType > &buffer, int startSample, int numSamples) |
| This method will conveniently apply the next numSamples number of envelope values to an AudioBuffer.
|
|
A very simple ADSR envelope class.
To use it, call setSampleRate() with the current sample rate and give it some parameters with setParameters() then call getNextSample() to get the envelope value to be applied to each audio sample or applyEnvelopeToBuffer() to apply the envelope to a whole buffer.
◆ ADSR()
◆ setParameters()
void ADSR::setParameters |
( |
const Parameters & |
newParameters | ) |
|
Sets the parameters that will be used by an ADSR object.
You must have called setSampleRate() with the correct sample rate before this otherwise the values may be incorrect!
- See also
- getParameters
References jassert.
◆ getParameters()
◆ isActive()
bool ADSR::isActive |
( |
| ) |
const |
|
noexcept |
Returns true if the envelope is in its attack, decay, sustain or release stage.
◆ setSampleRate()
void ADSR::setSampleRate |
( |
double |
newSampleRate | ) |
|
|
noexcept |
◆ reset()
Resets the envelope to an idle state.
◆ noteOn()
Starts the attack phase of the envelope.
◆ noteOff()
Starts the release phase of the envelope.
◆ getNextSample()
float ADSR::getNextSample |
( |
| ) |
|
|
noexcept |
◆ applyEnvelopeToBuffer()
template<typename FloatType >
void ADSR::applyEnvelopeToBuffer |
( |
AudioBuffer< FloatType > & |
buffer, |
|
|
int |
startSample, |
|
|
int |
numSamples |
|
) |
| |
The documentation for this class was generated from the following file: