Remarks
Applies a filter that removes the main component of the lead vocal from the given portion of sound under editing.
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 VocalRemovalApply (
nStartPosition as Int32,
nEndPosition as Int32,
nVoiceAttenuation as Int32,
nSoundGain as Int32,
nCutoffFrequency as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes VocalRemovalApply (
Int32 nStartPosition,
Int32 nEndPosition,
int nVoiceAttenuation,
int nSoundGain,
int nCutoffFrequency
);
|
|
[C++]
public: enumErrorCodes VocalRemovalApply (
Int32 nStartPosition,
Int32 nEndPosition,
int nVoiceAttenuation,
int nSoundGain,
int nCutoffFrequency
);
|
|
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.
|
nVoiceAttenuation
|
Numeric value representing the voice attenuation factor expressed in percentage.
This parameter can assume values from 0 to 100 where 0 means that no attenuation is performed on the lead vocal while 100 means that the lead vocal is totally attenuated: a background reverb of the lead voice could be still heard because, trying to remove this reverb, could cause the song to be attenuated in other components that need to remain as they are.
|
nSoundGain
|
Numeric value representing the gain applied to the filtered sound expressed in percentage. Typically this parameter should be set to 100 which leaves the original sound level unchanged during filtering; values under 100 reduce the sound level while values above 100 amplify the sound level.
|
nCutoffFrequency
|
Numeric value representing the cutoff frequency, expressed in Hz, under which the algorithm is not applied. For obtaining best results, typically this parameter should be set to values around 200.
|
Return value
Value
|
Meaning
|
|
|
Negative value
|
An error occurred (see the LastError property for further error details)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
