|
Effects.AutoWahApply method |
  
|
|
Effects.AutoWahApply method |
|
Remarks
Applies an AutoWah effect to the given portion of sound under editing.
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.
During the execution of the editing session the CallbackEditPerc delegate is invoked in order to notify about the percentage of advancement.
For further details about callback delegates see the How to synchronize the container application with the API tutorial.
For further details about methods related to the use of special effects refer to the EffectsMan class.
Syntax
[Visual Basic] Public Function AutoWahApply ( nStartPosition as Int32, nEndPosition as Int32, nAffectedChannel as enumChannelMasks, fDryMix as Single, fWetMix as Single, fFeedback as Single, fRate as Single, fRange as Single, fFrequency as Single ) as enumErrorCodes |
[C#] public enumErrorCodes AutoWahApply ( Int32 nStartPosition, Int32 nEndPosition, enumChannelMasks nAffectedChannel, float fDryMix, float fWetMix, float fFeedback, float fRate, float fRange, float fFrequency ); |
[C++] public: enumErrorCodes AutoWahApply ( Int32 nStartPosition, Int32 nEndPosition, enumChannelMasks nAffectedChannel, float fDryMix, float fWetMix, float fFeedback, float fRate, float fRange, float fFrequency ); |
Parameter |
Description |
||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
nStartPosition |
Start position, expressed in milliseconds, of the affected sound range. |
||||||||||||||||||||||||||||||||||||
nEndPosition |
End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound. |
||||||||||||||||||||||||||||||||||||
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. |
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. |
