EqualizerBandGetFrequency method

EqualizerBandGetFrequency 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 EqualizerBandGetFrequency (

nPlayerIndex as Int16,

nIndex as Int32

) as float

[C#]

public float EqualizerBandGetFrequency (

Int16 nPlayerIndex,

Int32 nIndex

);

[C++]

public: float EqualizerBandGetFrequency (

Int16 nPlayerIndex,

Int32 nIndex

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
nIndex	Zero-based index of the equalizer's band

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
Value >= 0	The current frequency, expressed in Hertz, of the given band