|
Effects.EqualizerBandParamsGet method |
  
|
|
Effects.EqualizerBandParamsGet method |
|
Remarks
Obtains 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.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] control.Effects.EqualizerBandParamsGet ( nPlayer as Integer, fFrequency as Single, fBandWidth as Single, fGain as Single ) as Single |
[C++] float control.Effects.EqualizerBandParamsGet ( short nPlayer, float fFrequency, float *fBandWidth, float *fGain ); |
Parameter |
Description |
|
|
nPlayer |
Number representing the zero-based index of the involved player |
fFrequency |
Center frequency of the band expressed in Hertz |
fBandWidth |
Reference that, on return from the method call, will contain the width of the band expressed in semi-tones |
fGain |
Reference that, on return from the method call, will contain the gain of the band expressed in dB |
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. |
