|
Effects.DynamicAmplifierApply method |
  
|
|
Effects.DynamicAmplifierApply method |
|
Remarks
Applies a dynamic amplifier effect to the given audio channels of the sound under editing
A successful call to this method will fire the SoundEditStarted event followed by a number of SoundEditPerc events and finally by the SoundEditDone event.
For further details about methods related to the use of special effects refer to the EffectsMan class.
Syntax
[Visual Basic] Public Function DynamicAmplifierApply ( nStartPosition as Int32, nEndPosition as Int32, nAffectedChannel as enumChannelMasks, fTarget as Single, fQuiet as Single, fRate as Single, fGain as Single, fDelay as Single ) as enumErrorCodes |
[C#] public enumErrorCodes DynamicAmplifierApply ( Int32 nStartPosition, Int32 nEndPosition, enumChannelMasks nAffectedChannel, float fTarget, float fQuiet, float fRate, float fGain, float fDelay ); |
[C++] public: enumErrorCodes DynamicAmplifierApply ( Int32 nStartPosition, Int32 nEndPosition, enumChannelMasks nAffectedChannel, float fTarget, float fQuiet, float fRate, float fGain, float fDelay ); |
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:
|
||||||||||||||||||||||||||||||||||||
fTarget |
Numeric value representing the target volume level. Supported values are up to 1 and can assume negative values. |
||||||||||||||||||||||||||||||||||||
fQuiet |
Quiet volume level. Supported values are in the range from 0 to 1. |
||||||||||||||||||||||||||||||||||||
fRate |
Amplification adjustment rate. Supported values are in the range from 0 to 1. |
||||||||||||||||||||||||||||||||||||
fGain |
Amplification level. Supported values are in the range from 0 to "n" with center value (no gain) at 1. |
||||||||||||||||||||||||||||||||||||
fDelay |
Delay in seconds before increasing level. Supported values are in the range from 0 to "n" |
Below some sample:
Effect type |
fTarget |
fQuiet |
fRate |
fGain |
fDelay |
|
|
|
|
|
|
Hard |
0.98 |
0.04 |
0.02 |
2.0 |
0.2 |
Medium |
0.94 |
0.03 |
0.01 |
1.0 |
0.35 |
Soft |
0.92 |
0.02 |
0.01 |
1.0 |
0.5 |
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. |
