Copyright © 2001-2008 MultiMedia Soft  Return to Table of contents

 

SetDirectXEffect method 

 

Remarks 

 

Applies/removes a certain DMO (DirectX Media Object) effect to the playing sound. Parameters related to the chosen effect can be retrieved through the GetDirectXEffectParams method and modified through the SetDirectXEffectParams method. 

 

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.SetDirectXEffect (  nPlayer as Integer,  nEffect as enumDirectXEffects,  bSet as enumBoolean  ) as enumErrorCodes

 

[C++]  short control.SetDirectXEffect (  short nPlayer,  short nEffect,  short bSet  );

 

 

Parameter	Description
nPlayer	Number representing the zero-based index of the involved player
nEffect	Numeric value that determines the effect to apply.  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 Wave reverb
bSet	Boolean value that enables/disables the chosen effect.  Supported values are the following:  Value Meaning BOOL_FALSE Disables the effect BOOL_TRUE Enables the effect

 

 

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.

 

 

 

 

 

 

 

 

 

 

 

 

 

Copyright © 2001-2008 MultiMedia Soft 

Return to Table of contents