Copyright © 2005-2018 MultiMedia Soft

Effects.DirectXEffectParamsSet method (WavesReverb)

Return to chapter overview

Remarks

 

Sets parameters related to the Waves Reverb effect. The current parameters for the chosen effect can be retrieved using the Effects.DirectXEffectParamsGet 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 DirectXEffectParamsSet (

nPlayerIndex as Int16,

ByRef fx as Microsoft.DirectX.DirectSound.EffectsWavesReverb

) as enumErrorCodes


 

[C#]

public enumErrorCodes DirectXEffectParamsSet (

Int16 nPlayerIndex,

ref Microsoft.DirectX.DirectSound.EffectsWavesReverb fx

);


 

[C++]

public: enumErrorCodes DirectXEffectParamsSet (

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.

Property

Meaning

 

 

HighFrequencyRtRatio

Retrieves and sets the high-frequency reverb time ratio.

Can range from WavesReverbEffect.HighFrequencyRtRationMin to WavesReverbEffect.HighFrequencyRtRationMax.

The default value is 0.001 or WavesReverbEffect.HighFrequencyRtRationDefault.

InGain

Retrieves and sets the input gain of signal expressed in decibels (dB).

Can range from WavesReverbEffect.InGainMin to WavesReverbEffect.InGainMax.

The default value is 0 db or WavesReverbEffect.InGainDefault.

ReverbMix

Retrieves and sets the reverb mix expressed in decibels (dB).

Can range from WavesReverbEffect.ReverbMixMin to WavesReverbEffect.ReverbMixMax.

The default value is 0 db or WavesReverbEffect.ReverbMixDefault.

ReverbTime

Retrieves and sets the reverb time expressed in milliseconds.

Can range from WavesReverbEffect.ReverbTimeMin to WavesReverbEffect.ReverbTimeMax.

The default value is 1000 ms or WavesReverbEffect.ReverbTimeDefault.

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

Note that if you should fill the fx structure with values out of range, you could get an exception of type ArgumentException

enumErrorCodes.NOERROR (0)

The method call was successful.