Effects.EqualizerBandCountGet method |
|
Remarks
Obtains the number of bands currently available inside 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] Public Function EqualizerBandCountGet ( nPlayerIndex as Int16, ByRef nCount as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes EqualizerBandCountGet ( Int16 nPlayerIndex, ref Int16 nCount ); |
[C++] public: enumErrorCodes EqualizerBandCountGet ( Int16 nPlayerIndex, Int16 __gc *nCount ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nCount |
Reference that, on return from the method call, will contain the number of bands available inside 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. |