Copyright © 2005-2018 MultiMedia Soft

Effects.DirectXEffectParamsSetFlanger method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets parameters related to the Flanger effect. The current parameters for the chosen effect can be retrieved using the Effects.DirectXEffectParamsGetFlanger 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 DirectXEffectParamsSetFlanger (

nPlayerIndex as Int16,

ByRef fx as Microsoft.DirectX.DirectSound.EffectsFlanger

) as enumErrorCodes


 

[C#]

public enumErrorCodes DirectXEffectParamsSetFlanger (

Int16 nPlayerIndex,

ref Microsoft.DirectX.DirectSound.EffectsFlanger fx

);


 

[C++]

public: enumErrorCodes DirectXEffectParamsSetFlanger (

Int16 nPlayerIndex,

Microsoft::DirectX::DirectSound::EffectsFlanger __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

 

 

Delay

Retrieves and sets the number of milliseconds the input is delayed before it is played back.

Can range from FlangerEffect.DelayMin to FlangerEffect.DelayMax.

The default value is 2ms.

Depth

Retrieves and sets the percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point.

Can range from FlangerEffect.DepthMin to FlangerEffect.DepthMax.

The default value is 100.

Feedback

Retrieves and sets the percentage of output signal to feed back into the effect's input.

Can range from FlangerEffect.FeedbackMin to FlangerEffect.FeedbackMax.

The default value is -50.

Frequency

Retrieves and sets the frequency of the LFO.

Can range from FlangerEffect.FrequencyMin to FlangerEffect.FrequencyMax.

The default value is 0.

Phase

Retrieves and sets the phase differential between left and right LFOs.

Can be set to on of the following:

- FlangerEffect.PhaseNeg180

- FlangerEffect.PhaseNeg90

- FlangerEffect.PhaseZero

- FlangerEffect.Phase90

- FlangerEffect.Phase180

Waveform

Retrieves and sets the waveform shape of the LFO.

Can be set to on of the following:

- FlangerEffect.WaveSine (default)

- FlangerEffect.WaveTriangle

WetDryMix

Retrieves and sets the ratio of wet (processed) signal to dry (unprocessed) signal.

Can range from FlangerEffect.WetDryMixMin to FlangerEffect.WetDryMixMax.

The default value is 50.

 

 

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.