Copyright © 2001-2018 MultiMedia Soft

Effects.FilterVocalRemoverApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a filter that removes the main component of the lead vocal from the playing song. An existing filter can be reset through the Effects.FilterVocalRemoverReset method.

 

The filter has only effect on the song currently loaded inside the player: in case a new song should be loaded, the filter should be reapplied.

When this kind of filter is activated on any of the players instanced by the control, eventual custom DSPs must be set to work with floating point samples through the CustomDSP.UseFloatSamples method.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

control.Effects.FilterVocalRemoverApply (

nPlayer as Integer,

nVoiceAttenuation as Integer,

nSoundGain as Integer,

nCutoffFrequency as Long

) as enumErrorCodes


 

[C++]

short control.Effects.FilterVocalRemoverApply (

short nPlayer,

short nVoiceAttenuation,

short nSoundGain,

long nCutoffFrequency

);


 

 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

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 call was successful.