Effects.EqualizerBandFrequencyGet method |
|
Remarks
Obtains the frequency of a given equalizer's band.
For further details about defining the equalizer settings refer to the How to create and use an Equalizer section.
Syntax
[Visual Basic] Public Function EqualizerBandFrequencyGet ( nPlayerIndex as Int16, nIndex as Int32, ByRef fFrequency As Single ) As enumErrorCodes |
[C#] public enumErrorCodes EqualizerBandFrequencyGet ( Int16 nPlayerIndex, Int32 nIndex, ref float fFrequency ); |
[C++] public: enumErrorCodes EqualizerBandFrequencyGet ( Int16 nPlayerIndex, Int32 nIndex, float __gc *fFrequency ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nIndex |
Zero-based index of the equalizer's band |
fFrequency |
Reference that, on return from the method call, will contain the current frequency, expressed in Hertz, of the given band |
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. |