Mezzanine::Audio::FlangerParameters Struct Reference

This is a struct containing all the parameters needed to describe an flanger effect. More...

#include <effectparameters.h>

Public Types
enum	FlangerWaveform { EFW_Sinusoid, EFW_Triangle }
	The shape of the wave if it were viewed on an oscillator. More...

Public Member Functions
	FlangerParameters (FlangerWaveform waveform=EFW_Triangle, Integer phase=0, Real rate=0.27f, Real depth=1.0f, Real feedback=-0.5f, Real delay=0.002f)
	Struct constructor. More...

Public Attributes
Real	Delay
	The average amount of time the sample is delayed before it is played back; with feedback, the amount of time between iterations of the sample. More...
Real	Depth
	The ratio by which the delay time is modulated by the LFO. More...
Real	Feedback
	This is the amount of the output signal level fed back into the effect's input. More...
Integer	Phase
	This changes the phase difference between the left and right LFO's. More...
Real	Rate
	The number of times per second the LFO controlling the amount of delay repeats. More...
FlangerWaveform	Waveform
	Selects the shape of the LFO waveform that controls the amount of the delay of the sampled signal.

Detailed Description

This is a struct containing all the parameters needed to describe an flanger effect.

The flanger effect creates a "tearing" or "whooshing" sound (like a jet flying overhead).

Definition at line 493 of file effectparameters.h.

Member Enumeration Documentation

enum Mezzanine::Audio::FlangerParameters::FlangerWaveform

The shape of the wave if it were viewed on an oscillator.

Enumerator
EFW_Sinusoid	A curved oscillation with smoother transitions at peak frequencies.
EFW_Triangle	A linear oscillation with rapid transitions at peak frequencies.

Definition at line 496 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::FlangerParameters::FlangerParameters ( FlangerWaveform  waveform = EFW_Triangle, Integer  phase = 0, Real  rate = 0.27f, Real  depth = 1.0f, Real  feedback = -0.5f, Real  delay = 0.002f  )

inline

Struct constructor.

Parameters

waveform	Selects the shape of the LFO waveform that controls the amount of the delay of the sampled signal.
phase	This changes the phase difference between the left and right LFO's.
rate	The number of times per second the LFO controlling the amount of delay repeats.
depth	The ratio by which the delay time is modulated by the LFO.
feedback	This is the amount of the output signal level fed back into the effect's input.
delay	The average amount of time the sample is delayed before it is played back; with feedback, the amount of time between iterations of the sample.

Definition at line 528 of file effectparameters.h.

Member Data Documentation

Real Mezzanine::Audio::FlangerParameters::Delay

The average amount of time the sample is delayed before it is played back; with feedback, the amount of time between iterations of the sample.

Remarks

Range: 0.0 to 0.004

Definition at line 519 of file effectparameters.h.

Real Mezzanine::Audio::FlangerParameters::Depth

The ratio by which the delay time is modulated by the LFO.

Remarks

Use this parameter to increase the pitch modulation.

Range: 0.0 to 1.0

Definition at line 512 of file effectparameters.h.

Real Mezzanine::Audio::FlangerParameters::Feedback

This is the amount of the output signal level fed back into the effect's input.

Remarks

A negative value will reverse the phase of the feedback signal. Use this parameter to create an "intense metallic" effect. At full magnitude, the identical sample will repeat endlessly. At less than full magnitude, the sample will repeat and fade out over time.

Range: -1.0 to 1.0

Definition at line 516 of file effectparameters.h.

Integer Mezzanine::Audio::FlangerParameters::Phase

This changes the phase difference between the left and right LFO's.

Remarks

At zero degrees the two LFOs are synchronized.

Range: -180 to 180

Definition at line 506 of file effectparameters.h.

Real Mezzanine::Audio::FlangerParameters::Rate

The number of times per second the LFO controlling the amount of delay repeats.

Remarks

Higher values increase the pitch modulation.

Range: 0.0 to 10.0

Definition at line 509 of file effectparameters.h.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Audio/effectparameters.h