Some effect descriptions (for Doxygen).

This commit is contained in:
James Crook 2015-05-09 17:36:54 +01:00
parent cb70fd3abd
commit ccc71c31b6
11 changed files with 11 additions and 11 deletions

View File

@ -10,7 +10,7 @@
*******************************************************************//**
\class EffectAmplify
\brief An Effect
\brief An Effect that makes a sound louder or softer.
This rewritten class supports a smart Amplify effect - it calculates
the maximum amount of gain that can be applied to all tracks without

View File

@ -9,7 +9,7 @@
*******************************************************************//**
\class EffectClickRemoval
\brief An Effect.
\brief An Effect for removing clicks.
Clicks are identified as small regions of high amplitude compared
to the surrounding chunk of sound. Anything sufficiently tall compared

View File

@ -18,7 +18,7 @@
\class EffectEqualization
\brief An Effect.
\brief An Effect that modifies volume in different frequency bands.
Performs filtering, using an FFT to do a FIR filter.
It lets the user draw an arbitrary envelope (using the same

View File

@ -9,7 +9,7 @@
*******************************************************************//**
\class EffectFade
\brief An Effect
\brief An Effect that reduces the volume to zero over achosen interval.
*//*******************************************************************/

View File

@ -9,7 +9,7 @@
******************************************************************//**
\class EffectLeveller
\brief An Effect
\brief An Effect that aims to selectively make softer sounds louder.
*//*******************************************************************/

View File

@ -10,7 +10,7 @@
*******************************************************************//**
\class EffectNormalize
\brief An Effect.
\brief An Effect to bring the peak level up to a chosen level.
*//*******************************************************************/

View File

@ -14,7 +14,7 @@
*******************************************************************//**
\class EffectPhaser
\brief An Effect
\brief An Effect that changes frequencies in a time varying manner.
*//*******************************************************************/

View File

@ -10,7 +10,7 @@
*******************************************************************//**
\class EffectRepeat
\brief An Effect.
\brief An Effect that repeats audio several times over.
*//****************************************************************//**

View File

@ -16,7 +16,7 @@
*//****************************************************************//**
\class EffectScienFilter
\brief An Effect.
\brief An Effect that applies 'classical' IIR filters.
Performs IIR filtering that emulates analog filters, specifically
Butterworth, Chebyshev Type I and Type II. Highpass and lowpass filters

View File

@ -9,7 +9,7 @@
*******************************************************************//**
\class EffectStereoToMono
\brief An Effect.
\brief An Effect to convert stereo to mono.
*//*******************************************************************/

View File

@ -14,7 +14,7 @@
*******************************************************************//**
\class EffectWahwah
\brief An Effect
\brief An Effect that adds a 'spectral glide'.
*//*******************************************************************/