Copyright © 2001-2016 MultiMedia Soft

Effects.DirectXEffectReset method

Previous pageReturn to chapter overviewNext page

Remarks

 

Removes a specific DMO (DirectX Media Object) effect, previously applied through the Effects.DirectXEffectApply method, from the playing sound.

 

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

 

 

Syntax

 

[Visual Basic]

control.Effects.DirectXEffectReset (

nPlayer as Integer,

nEffect as enumDirectXEffects

) as enumErrorCodes


 

[C++]

short control.Effects.DirectXEffectReset (

short nPlayer,

short nEffect

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nEffect

Numeric value that determines the effect to remove.

Supported values are the following:

Mnemonic constant

Value

Meaning

DX_CHORUS

0

Chorus

DX_COMPRESSOR

1

Compressor

DX_DISTORTION

2

Distortion

DX_ECHO

3

Echo

DX_FLANGER

4

Flanger

DX_GARGLE

5

Gargle

DX_I3DL2REVERB

6

I3DL2 environmental reverb

DX_REVERB

8

Wave reverb

 

 

Return value

 

Value

Meaning

 

 

enumErrorCodes.ERR_NOERROR (0)

The call was successful

Negative value

An error occurred: see the LastError property for further error details or for a list of the possible error values.