Copyright © 2001-2018 MultiMedia Soft

Effects.EqualizerEnable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables 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.EqualizerEnable (

nPlayer as Integer,

bEnable as enumBoolean

) as enumErrorCodes


 

[C++]

short control.Effects.EqualizerEnable (

short nPlayer,

short bEnable

);


 

 

Parameter

Description

 

 

nPlayer

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:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Disable the equalizer

BOOL_TRUE

1

Enable 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.