Classes > Effects Class > Methods > Effects.DirectXEffectParamsSetGargle method

Remarks

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

nPlayerIndex as Int16,

ByRef fx as Microsoft.DirectX.DirectSound.EffectsGargle

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXEffectParamsSetGargle (

Int16 nPlayerIndex,

ref Microsoft.DirectX.DirectSound.EffectsGargle fx

);

[C++]

public: enumErrorCodes DirectXEffectParamsSetGargle (

Int16 nPlayerIndex,

Microsoft::DirectX::DirectSound::EffectsGargle __gc *fx

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the involved player

Reference to the effect structure containing parameters to apply.

Property	Meaning

RateHz	Retrieves and sets the rate of modulation expressed in Hertz. Can range from GargleEffect.RateHzMin to GargleEffect.RateHzMax. The default value is 20.
WaveShape	Retrieves and sets the shape of the modulation waveform. Can be set to one of the following: - GargleEffect.WaveTriangle (default) - GargleEffect.WaveSquare

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.