Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::Audio::AutowahParameters Struct Reference

This is a struct containing all the parameters needed to describe an Auto-Wah effect. More...

#include <effectparameters.h>

Public Member Functions

 AutowahParameters (Real attackTime=0.06f, Real releaseTime=0.06f, Real resonance=1000.0f, Real peakGain=11.22f)
 Struct constructor. More...
 

Public Attributes

Real AttackTime
 This property controls the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal. More...
 
Real PeakGain
 This property controls the input signal level at which the band-pass filter will be fully opened. More...
 
Real ReleaseTime
 This property controls the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends. More...
 
Real Resonance
 This property controls the resonant peak, sometimes known as emphasis or Q, of the auto-wah band-pass filter. More...
 

Detailed Description

This is a struct containing all the parameters needed to describe an Auto-Wah effect.

The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument.

Definition at line 727 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::AutowahParameters::AutowahParameters ( Real  attackTime = 0.06f,
Real  releaseTime = 0.06f,
Real  resonance = 1000.0f,
Real  peakGain = 11.22f 
)
inline

Struct constructor.

Parameters
attackTimeThis property controls the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal.
releaseTimeThis property controls the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends.
resonanceThis property controls the resonant peak, sometimes known as emphasis or Q, of the auto-wah band-pass filter.
peakGainThis property controls the input signal level at which the band-pass filter will be fully opened.

Definition at line 748 of file effectparameters.h.

Member Data Documentation

Real Mezzanine::Audio::AutowahParameters::AttackTime

This property controls the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal.

Remarks
Range: 0.0001 to 1.0

Definition at line 731 of file effectparameters.h.

Real Mezzanine::Audio::AutowahParameters::PeakGain

This property controls the input signal level at which the band-pass filter will be fully opened.

Remarks
Range: 0.00003 to 31621.0

Definition at line 741 of file effectparameters.h.

Real Mezzanine::Audio::AutowahParameters::ReleaseTime

This property controls the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends.

Remarks
Range: 0.0001 to 1.0

Definition at line 734 of file effectparameters.h.

Real Mezzanine::Audio::AutowahParameters::Resonance

This property controls the resonant peak, sometimes known as emphasis or Q, of the auto-wah band-pass filter.

Remarks
Resonance occurs when the effect boosts the frequency content of the sound around the point at which the filter is working. A high value promotes a highly resonant, sharp sounding effect.

Range: 2.0 to 1000.0

Definition at line 738 of file effectparameters.h.


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