Mezzanine::Audio::ChorusParameters Struct Reference

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

#include <effectparameters.h>

Public Types
enum	ChorusWaveform { ECW_Sinusoid, ECW_Triangle }
	The shape of the wave if it were viewed on an oscillator. More...

Public Member Functions
	ChorusParameters (ChorusWaveform waveform=ECW_Triangle, Integer phase=90, Real rate=1.1f, Real depth=0.1f, Real feedback=0.25f, Real delay=0.016f)
	Struct constructor. More...

Public Attributes
Real	Delay
	This property controls the average amount of time the sample is delayed before it is played back. More...
Real	Depth
	This property controls the amount by which the delay time is modulated by the Low Frequency Oscillation. More...
Real	Feedback
	This property controls the amount of processed signal that is fed back to the input of the chorus effect. More...
Integer	Phase
	This property controls the phase difference between the left and rightLow Frequency Oscillation's. More...
Real	Rate
	This property sets the modulation rate of the Low Frequency Oscillation that controls the delay time of the delayed signals. More...
ChorusWaveform	Waveform
	This property sets the waveform shape of the Low Frequency Oscillation that controls the delay time of the delayed signals.

Detailed Description

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

The chorus effect essentially replays the input audio accompanied by another slightly delayed version of the signal, creating a "doubling" effect.

Definition at line 362 of file effectparameters.h.

Member Enumeration Documentation

enum Mezzanine::Audio::ChorusParameters::ChorusWaveform

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

Enumerator
ECW_Sinusoid	A curved oscillation with smoother transitions at peak frequencies.
ECW_Triangle	A linear oscillation with rapid transitions at peak frequencies.

Definition at line 365 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::ChorusParameters::ChorusParameters ( ChorusWaveform  waveform = ECW_Triangle, Integer  phase = 90, Real  rate = 1.1f, Real  depth = 0.1f, Real  feedback = 0.25f, Real  delay = 0.016f  )

inline

Struct constructor.

Parameters

waveform	This property sets the waveform shape of the Low Frequency Oscillation that controls the delay time of the delayed signals.
phase	This property controls the phase difference between the left and rightLow Frequency Oscillation's.
rate	This property sets the modulation rate of the Low Frequency Oscillation that controls the delay time of the delayed signals.
depth	This property controls the amount by which the delay time is modulated by the Low Frequency Oscillation.
feedback	This property controls the amount of processed signal that is fed back to the input of the chorus effect.
delay	This property controls the average amount of time the sample is delayed before it is played back.

Definition at line 399 of file effectparameters.h.

Member Data Documentation

Real Mezzanine::Audio::ChorusParameters::Delay

This property controls the average amount of time the sample is delayed before it is played back.

Remarks

This property can also control with feedback, the amount of time between iterations of the sample. Larger values lower the pitch. Smaller values make the chorus sound like a flanger, but with different frequency characteristics.

Range: 0.0 to 0.016

Definition at line 390 of file effectparameters.h.

Real Mezzanine::Audio::ChorusParameters::Depth

This property controls the amount by which the delay time is modulated by the Low Frequency Oscillation.

Remarks

Range: 0.0 to 1.0

Definition at line 382 of file effectparameters.h.

Real Mezzanine::Audio::ChorusParameters::Feedback

This property controls the amount of processed signal that is fed back to the input of the chorus effect.

Remarks

Negative values will reverse the phase of the feedback signal. At full magnitude the identical sample will repeat endlessly. At lower magnitudes the sample will repeat and fade out over time. Use this parameter to create a "cascading" chorus effect.

Range: -1.0 to 1.0

Definition at line 386 of file effectparameters.h.

Integer Mezzanine::Audio::ChorusParameters::Phase

This property controls the phase difference between the left and rightLow Frequency Oscillation's.

Remarks

At zero degrees the two LFOs are synchronized. Use this parameter to create the illusion of an expanded stereo field of the output signal.

Range: -180 to 180

Definition at line 376 of file effectparameters.h.

Real Mezzanine::Audio::ChorusParameters::Rate

This property sets the modulation rate of the Low Frequency Oscillation that controls the delay time of the delayed signals.

Remarks

Range: 0.0 to 10.0

Definition at line 379 of file effectparameters.h.

---

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

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