Copyright © 2001-2016 MultiMedia Soft

Effects.DcOffsetRemovalIsEnabled method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if real-time DC offset removal effect has been enabled on the given player through the Effects.DcOffsetRemovalEnable method.

 

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

 

 

Syntax

 

[Visual Basic]

control.Effects.DcOffsetRemovalIsEnabled (

nPlayer as Integer,

bEnabled as enumBoolean

) as enumErrorCodes


 

[C++]

short control.Effects.DcOffsetRemovalIsEnabled (

short nPlayer,

long *bEnabled

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

bEnabled

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

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE (default)

0

Real-time DC offset removal is not enabled

BOOL_TRUE

1

Real-time DC offset removal is enabled

 

 

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.