Classes > Effects Class > Methods > Effects.DirectXEffectIsApplied method

Remarks

Verifies if the given DMO effect has been applied to the given player through the Effects.DirectXEffectApply method.

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

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

Syntax

[Visual Basic]

Public DirectXEffectIsApplied (

nPlayerIndex as integer,

nEffect as enumDirectXEffects,

ByRef bApplied as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXEffectIsApplied (

short nPlayerIndex,

enumDirectXEffects nEffect,

ref bool bApplied

);

[C++]

public: enumErrorCodes DirectXEffectIsApplied (

short nPlayerIndex,

enumDirectXEffects nEffect,

bool __gc *bApplied

);

Parameter

Description

nPlayerIndex

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_REVERB	8	Reverb

bApplied

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

Supported values are the following:

Mnemonic constant	Meaning
false	The given effect has not been applied
true	The given effect has been applied

Return value

Value	Meaning

false	The given effect has not been applied
true	The given effect has been applied