JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
juce::Reverb Class Reference

Performs a simple reverb effect on a stream of audio data. More...

#include "juce_Reverb.h"

Classes

struct  Parameters
 Holds the parameters being used by a Reverb object. More...
 

Public Member Functions

const ParametersgetParameters () const noexcept
 Returns the reverb's current parameters.
 
void setParameters (const Parameters &newParams)
 Applies a new set of parameters to the reverb.
 
void setSampleRate (const double sampleRate)
 Sets the sample rate that will be used for the reverb.
 
void reset ()
 Clears the reverb's buffers.
 
void processStereo (float *const left, float *const right, const int numSamples) noexcept
 Applies the reverb to two stereo channels of audio data.
 
void processMono (float *const samples, const int numSamples) noexcept
 Applies the reverb to a single mono channel of audio data.
 

Detailed Description

Performs a simple reverb effect on a stream of audio data.

This is a simple stereo reverb, based on the technique and tunings used in FreeVerb. Use setSampleRate() to prepare it, and then call processStereo() or processMono() to apply the reverb to your audio data.

See also
ReverbAudioSource

@tags{Audio}

Definition at line 38 of file juce_Reverb.h.


Class Documentation

◆ juce::Reverb::Parameters

struct juce::Reverb::Parameters

Holds the parameters being used by a Reverb object.

Definition at line 50 of file juce_Reverb.h.

Class Members
float damping Damping, 0 to 1.0, where 0 is not damped, 1.0 is fully damped.
float dryLevel Dry level, 0 to 1.0.
float freezeMode Freeze mode - values < 0.5 are "normal" mode, values > 0.5 put the reverb into a continuous feedback loop.
float roomSize Room size, 0 to 1.0, where 1.0 is big, 0 is small.
float wetLevel Wet level, 0 to 1.0.
float width Reverb width, 0 to 1.0, where 1.0 is very wide.

Constructor & Destructor Documentation

◆ Reverb()

juce::Reverb::Reverb ( )

Definition at line 42 of file juce_Reverb.h.

Member Function Documentation

◆ getParameters()

const Parameters & juce::Reverb::getParameters ( ) const
noexcept

Returns the reverb's current parameters.

Definition at line 63 of file juce_Reverb.h.

◆ processMono()

void juce::Reverb::processMono ( float *const  samples,
const int  numSamples 
)
noexcept

Applies the reverb to a single mono channel of audio data.

Definition at line 169 of file juce_Reverb.h.

◆ processStereo()

void juce::Reverb::processStereo ( float *const  left,
float *const  right,
const int  numSamples 
)
noexcept

Applies the reverb to two stereo channels of audio data.

Definition at line 132 of file juce_Reverb.h.

◆ reset()

void juce::Reverb::reset ( )

Clears the reverb's buffers.

Definition at line 118 of file juce_Reverb.h.

◆ setParameters()

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

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.

Definition at line 69 of file juce_Reverb.h.

◆ setSampleRate()

void juce::Reverb::setSampleRate ( const double  sampleRate)

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

You must call this before the process methods, in order to tell it the correct sample rate.

Definition at line 88 of file juce_Reverb.h.


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