Copyright © 2001-2018 MultiMedia Soft

Effects.BassBoostIsApplied method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if the bass boost DSP has been applied to the given player through the Effects.BassBoostApply method.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

control.Effects.BassBoostIsApplied (

nPlayer as Integer,

bApplied as enumBoolean

) as enumErrorCodes


 

[C++]

short control.Effects.BassBoostIsApplied (

short nPlayer,

long *bApplied

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

bApplied

Reference that, on return from the method call, will contain the boolean value specifying if the DSP is currently applied.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE (default)

0

The DSP has not been applied

BOOL_TRUE

1

The DSP has been applied

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The call was successful.