Copyright © 2001-2011 MultiMedia Soft

GetDirectXEffect method

Previous pageReturn to chapter overviewNext page

Remarks

 

Checks if the given DMO effect has been applied to the given player.

 

DirectX effects requires the availability of DirectX version 8 or higher on the target system and can be applied only if the IsDirectX8Avail method returns TRUE.

 

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

 

 

Syntax

 

[Visual Basic]

control.GetDirectXEffect (

nPlayer as Integer,

nEffect as enumDirectXEffects

) as boolean


 

[C++]

short control.GetDirectXEffect (

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

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_PARAMEQ

7

Parametric equalizer

DX_REVERB

8

Reverb

 

 

Return value

 

Value

Meaning

 

 

FALSE

The given effect has not been applied

TRUE

The given effect has been applied