|
Effects.AutoWahApply method |
  
|
|
Effects.AutoWahApply method |
|
Remarks
Applies an AutoWah effect on the playing song. This DSP effect can be reset through the Effects.AutoWahReset method.
The effect implements the AutoWah by using 4-stage phaser effect which moves a peak in the frequency response up and down the frequency spectrum by amplitude of input signal.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function AutoWahApply ( nPlayerIndex as Int16, nAffectedChannel as enumChannelMasks, fDryMix as Single, fWetMix as Single, fFeedback as Single, fRate as Single, fRange as Single, fFrequency as Single, nPriority as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes AutoWahApply ( Int16 nPlayerIndex, enumChannelMasks nAffectedChannel, float fDryMix, float fWetMix, float fFeedback, float fRate, float fRange, float fFrequency, Int16 nPriority ); |
[C++] public: enumErrorCodes AutoWahApply ( Int16 nPlayerIndex, enumChannelMasks nAffectedChannel, float fDryMix, float fWetMix, float fFeedback, float fRate, float fRange, float fFrequency, Int16 nPriority ); |
Parameter |
Description |
||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
||||||||||||||||||||||||||||||||||||
nAffectedChannel |
Numeric value that determines the combination of affected channels. Supported values are the following:
|
||||||||||||||||||||||||||||||||||||
fDryMix |
Numeric value representing the Dry (unaffected) signal mix. Supported values are in the range from -2 to +2. |
||||||||||||||||||||||||||||||||||||
fWetMix |
Numeric value representing the Wet (affected) signal mix. Supported values are in the range from -2 to +2. |
||||||||||||||||||||||||||||||||||||
fFeedback |
Numeric value representing the output signal to feed back into input. Supported values are in the range from -1 to +1. |
||||||||||||||||||||||||||||||||||||
fRate |
Numeric value representing the rate of sweep expressed in cycles per second. Supported values are in the range from 0 to 10. |
||||||||||||||||||||||||||||||||||||
fRange |
Numeric value representing the sweep range expressed in octaves. Supported values are in the range from 0 to 10. |
||||||||||||||||||||||||||||||||||||
fFrequency |
Numeric value representing the base frequency of sweep range. Supported values are in the range from 0 to 1000. |
||||||||||||||||||||||||||||||||||||
nPriority |
Effect's priority level inside the chain of DirectX effects, custom DSP effects and VST effects. Effects with higher priority are applied before effects with lower priority; in case more effects should have the same priority, they would be invoked in the same order that they were added. |
The fDryMix is the volume of input signal & the fWetMix is the volume of delayed signal. The fFeedback sets feedback of AutoWah(phaser). The fRate and fRange control how fast and far the frequency notches move. The fRate is the rate of sweep in cycles per second, fRange is the width of sweep in octaves. And the the fFrequency is the base frequency of sweep.
Below some sample:
Effect type |
fDryMix |
fWetMix |
fFeedback |
fRate |
fRange |
fFrequency |
|
|
|
|
|
|
|
Slow Auto Wah |
0.500 |
1.500 |
0.5 |
2.0 |
4.3 |
50.0 |
Fast Auto Wah |
0.500 |
1.500 |
0.5 |
5.0 |
5.3 |
50.0 |
Hi Fast Auto Wah |
0.500 |
1.500 |
0.5 |
5.0 |
4.3 |
500.0 |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
