juce::dsp::Gain< FloatType > Class Template Reference

Applies a gain to audio samples as single samples or AudioBlocks. More...

#include "juce_Gain.h"

Public Member Functions
void	setGainLinear (FloatType newGain) noexcept
	Applies a new gain as a linear value.
void	setGainDecibels (FloatType newGainDecibels) noexcept
	Applies a new gain as a decibel value.
FloatType	getGainLinear () const noexcept
	Returns the current gain as a linear value.
FloatType	getGainDecibels () const noexcept
	Returns the current gain in decibels.
void	setRampDurationSeconds (double newDurationSeconds) noexcept
	Sets the length of the ramp used for smoothing gain changes.
double	getRampDurationSeconds () const noexcept
	Returns the ramp duration in seconds.
bool	isSmoothing () const noexcept
	Returns true if the current value is currently being interpolated.
void	prepare (const ProcessSpec &spec) noexcept
	Called before processing starts.
void	reset () noexcept
	Resets the internal state of the gain.
template<typename SampleType >
SampleType JUCE_VECTOR_CALLTYPE	processSample (SampleType s) noexcept
	Returns the result of processing a single sample.
template<typename ProcessContext >
void	process (const ProcessContext &context) noexcept
	Processes the input and output buffers supplied in the processing context.

Detailed Description

template<typename FloatType>
class juce::dsp::Gain< FloatType >

Applies a gain to audio samples as single samples or AudioBlocks.

@tags{DSP}

Definition at line 35 of file juce_Gain.h.

Member Function Documentation

getGainDecibels()

template<typename FloatType >

FloatType juce::dsp::Gain< FloatType >::getGainDecibels ( ) const

noexcept

Returns the current gain in decibels.

Definition at line 51 of file juce_Gain.h.

getGainLinear()

template<typename FloatType >

FloatType juce::dsp::Gain< FloatType >::getGainLinear ( ) const

noexcept

Returns the current gain as a linear value.

Definition at line 48 of file juce_Gain.h.

getRampDurationSeconds()

template<typename FloatType >

double juce::dsp::Gain< FloatType >::getRampDurationSeconds ( ) const

noexcept

Returns the ramp duration in seconds.

Definition at line 64 of file juce_Gain.h.

isSmoothing()

template<typename FloatType >

bool juce::dsp::Gain< FloatType >::isSmoothing ( ) const

noexcept

Returns true if the current value is currently being interpolated.

Definition at line 67 of file juce_Gain.h.

prepare()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::prepare ( const ProcessSpec &  spec )

noexcept

Called before processing starts.

Definition at line 71 of file juce_Gain.h.

process()

template<typename FloatType >

template<typename ProcessContext >

void juce::dsp::Gain< FloatType >::process ( const ProcessContext &  context )

noexcept

Processes the input and output buffers supplied in the processing context.

Definition at line 94 of file juce_Gain.h.

processSample()

template<typename FloatType >

template<typename SampleType >

SampleType JUCE_VECTOR_CALLTYPE juce::dsp::Gain< FloatType >::processSample ( SampleType  s )

noexcept

Returns the result of processing a single sample.

Definition at line 87 of file juce_Gain.h.

reset()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::reset ( )

noexcept

Resets the internal state of the gain.

Definition at line 78 of file juce_Gain.h.

setGainDecibels()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setGainDecibels ( FloatType  newGainDecibels )

noexcept

Applies a new gain as a decibel value.

Definition at line 45 of file juce_Gain.h.

setGainLinear()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setGainLinear ( FloatType  newGain )

noexcept

Applies a new gain as a linear value.

Definition at line 42 of file juce_Gain.h.

setRampDurationSeconds()

template<typename FloatType >

void juce::dsp::Gain< FloatType >::setRampDurationSeconds ( double  newDurationSeconds )

noexcept

Sets the length of the ramp used for smoothing gain changes.

Definition at line 54 of file juce_Gain.h.

---

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

• juce_dsp/widgets/juce_Gain.h