|
Effects.EqualizerEnable method |
  
|
|
Effects.EqualizerEnable method |
|
Remarks
Enables/disables 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 EqualizerEnable ( nPlayerIndex as Int16, bEnable as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes EqualizerEnable ( Int16 nPlayerIndex, bool bEnable ); |
[C++] public: enumErrorCodes EqualizerEnable ( Int16 nPlayerIndex, bool bEnable ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
||||||
bEnable |
Boolean value that specifies if the equalizer must be enabled or disabled. Supported values are the following:
|
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. |
