Copyright © 2005-2018 MultiMedia Soft

Effects.DirectXEffectParamsGet method (WavesReverb)

Return to chapter overview

Remarks

 

Retrieves parameters related to the Waves Reverb effect. These parameters can be changed using the Effects.DirectXEffectParamsSet 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 Function DirectXEffectParamsGet (

nPlayerIndex as Int16,

ByRef fx as Microsoft.DirectX.DirectSound.EffectsWavesReverb

) as enumErrorCodes


 

[C#]

public enumErrorCodes DirectXEffectParamsGet (

Int16 nPlayerIndex,

ref Microsoft.DirectX.DirectSound.EffectsWavesReverb fx

);


 

[C++]

public: enumErrorCodes DirectXEffectParamsGet (

Int16 nPlayerIndex,

Microsoft::DirectX::DirectSound::EffectsWavesReverb __gc *fx

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

fx

Reference to the effect structure containing parameters to apply. For details about the fields of this structure see the related Effects.DirectXEffectParamsSet method.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.