Remarks
Sets parameters related to a given band of 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 EqualizerBandSetParams (
nPlayerIndex as Int16,
fFrequency as float,
fBandWidth as float,
fGain as float
) as float
|
|
[C#]
public float EqualizerBandSetParams (
Int16 nPlayerIndex,
float fFrequency,
float fBandWidth,
float fGain
);
|
|
[C++]
public: float EqualizerBandSetParams (
Int16 nPlayerIndex,
float fFrequency,
float fBandWidth,
float fGain
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
fFrequency
|
Center frequency of the band expressed in Hertz
|
fBandWidth
|
Width of the band expressed in semi-tones
|
fGain
|
Gain of the band expressed in dB. Typical values are in the range from -15 to 15 dB but you can also enter values outside of this range.
|
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.
|
|