juce::ADSR Class Reference

A very simple ADSR envelope class. More...

#include "juce_ADSR.h"

Classes
struct	Parameters
	Holds the parameters being used by an ADSR object. More...

Public Member Functions
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.

Detailed Description

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.

Do not change the parameters during playback. If you change the parameters before the release stage has completed then you must call reset() before the next call to noteOn().

@tags{Audio}

Definition at line 40 of file juce_ADSR.h.

Constructor & Destructor Documentation

ADSR()

juce::ADSR::ADSR

(

)

Definition at line 44 of file juce_ADSR.h.

Member Function Documentation

applyEnvelopeToBuffer()

template<typename FloatType >

void juce::ADSR::applyEnvelopeToBuffer	(	AudioBuffer< FloatType > &	buffer,
		int	startSample,
		int	numSamples
	)

This method will conveniently apply the next numSamples number of envelope values to an AudioBuffer.

See also

getNextSample

Definition at line 219 of file juce_ADSR.h.

getNextSample()

float juce::ADSR::getNextSample ( )

noexcept

Returns the next sample value for an ADSR object.

See also

applyEnvelopeToBuffer

Definition at line 158 of file juce_ADSR.h.

getParameters()

const Parameters & juce::ADSR::getParameters ( ) const

noexcept

Returns the parameters currently being used by an ADSR object.

See also

setParameters

Definition at line 93 of file juce_ADSR.h.

isActive()

bool juce::ADSR::isActive ( ) const

noexcept

Returns true if the envelope is in its attack, decay, sustain or release stage.

Definition at line 96 of file juce_ADSR.h.

noteOff()

void juce::ADSR::noteOff ( )

noexcept

Starts the release phase of the envelope.

Definition at line 137 of file juce_ADSR.h.

noteOn()

void juce::ADSR::noteOn ( )

noexcept

Starts the attack phase of the envelope.

Definition at line 118 of file juce_ADSR.h.

reset()

void juce::ADSR::reset ( )

noexcept

Resets the envelope to an idle state.

Definition at line 111 of file juce_ADSR.h.

setParameters()

void juce::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

Definition at line 80 of file juce_ADSR.h.

setSampleRate()

void juce::ADSR::setSampleRate ( double  newSampleRate )

noexcept

Sets the sample rate that will be used for the envelope.

This must be called before the getNextSample() or setParameters() methods.

Definition at line 103 of file juce_ADSR.h.

---

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

• juce_audio_basics/utilities/juce_ADSR.h