Effects.EqualizerBandRemove method |
|
Remarks
Removes the band related to a given frequency from the equalizer.
For further details about defining the equalizer settings refer to the How to create and use an Equalizer section.
Syntax
[Visual Basic] Public Function EqualizerBandRemove ( nPlayerIndex as Int16, fFrequency As Single ) as enumErrorCodes |
[C#] public enumErrorCodes EqualizerBandRemove ( Int16 nPlayerIndex, float fFrequency ); |
[C++] public: enumErrorCodes EqualizerBandRemove ( Int16 nPlayerIndex, float fFrequency ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
fFrequency |
Frequency, expressed in Hertz, of the band to remove from the equalizer |
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. |