JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::dsp::Reverb Class Reference

Processor wrapper around juce::Reverb for easy integration into ProcessorChain. More...

#include <juce_Reverb.h>

Collaboration diagram for juce::dsp::Reverb:

Public Types

using Parameters = juce::Reverb::Parameters
 

Public Member Functions

 Reverb ()=default
 Creates an uninitialised Reverb processor. More...
 
const ParametersgetParameters () const noexcept
 Returns the reverb's current parameters. More...
 
bool isEnabled () const noexcept
 Returns true if the reverb is enabled. More...
 
void prepare (const ProcessSpec &spec)
 Initialises the reverb. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) noexcept
 Applies the reverb to a mono or stereo buffer. More...
 
void reset () noexcept
 Resets the reverb's internal state. More...
 
void setEnabled (bool newValue) noexcept
 Enables/disables the reverb. More...
 
void setParameters (const Parameters &newParams)
 Applies a new set of parameters to the reverb. More...
 

Private Attributes

bool enabled = true
 
juce::Reverb reverb
 

Detailed Description

Processor wrapper around juce::Reverb for easy integration into ProcessorChain.

@tags{DSP}

Member Typedef Documentation

◆ Parameters

Constructor & Destructor Documentation

◆ Reverb()

juce::dsp::Reverb::Reverb ( )
default

Creates an uninitialised Reverb processor.

Call prepare() before first use.

Member Function Documentation

◆ getParameters()

const Parameters& juce::dsp::Reverb::getParameters ( ) const
inlinenoexcept

Returns the reverb's current parameters.

References juce::Reverb::getParameters(), and reverb.

◆ isEnabled()

bool juce::dsp::Reverb::isEnabled ( ) const
inlinenoexcept

Returns true if the reverb is enabled.

References enabled.

◆ prepare()

void juce::dsp::Reverb::prepare ( const ProcessSpec spec)
inline

Initialises the reverb.

References reverb, juce::dsp::ProcessSpec::sampleRate, and juce::Reverb::setSampleRate().

◆ process()

template<typename ProcessContext >
void juce::dsp::Reverb::process ( const ProcessContext context)
inlinenoexcept

Applies the reverb to a mono or stereo buffer.

References enabled, jassert, jassertfalse, juce::Reverb::processMono(), juce::Reverb::processStereo(), and reverb.

◆ reset()

void juce::dsp::Reverb::reset ( )
inlinenoexcept

Resets the reverb's internal state.

References juce::Reverb::reset(), and reverb.

◆ setEnabled()

void juce::dsp::Reverb::setEnabled ( bool  newValue)
inlinenoexcept

Enables/disables the reverb.

References enabled.

◆ setParameters()

void juce::dsp::Reverb::setParameters ( const Parameters newParams)
inline

Applies a new set of parameters to the reverb.

Note that this doesn't attempt to lock the reverb, so if you call this in parallel with the process method, you may get artifacts.

References reverb, and juce::Reverb::setParameters().

Member Data Documentation

◆ enabled

bool juce::dsp::Reverb::enabled = true
private

Referenced by isEnabled(), process(), and setEnabled().

◆ reverb

juce::Reverb juce::dsp::Reverb::reverb
private

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