Classes > EffectsMan class > Methods > Effects.DirectXApplyGargle method

Remarks

Applies a Gargle effect to the given portion of sound under editing.

DirectX effects requires the availability of DirectX version 8 or higher on the target system and can be applied only if a call to the GetDirectSoundVersion method returns a value higher than 7.

For further details about methods related to the use of special effects refer to the EffectsMan class.

Syntax

[Visual Basic]

Public Function DirectXApplyGargle (

nStartPosition as Int32,

nEndPosition as Int32,

fx as Microsoft.DirectX.DirectSound.EffectsGargle

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXApplyGargle (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft.DirectX.DirectSound.EffectsGargle fx

);

[C++]

public: enumErrorCodes DirectXApplyGargle (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft::DirectX::DirectSound::EffectsGargle fx

);

Parameter

Description

nStartPosition

Start position, expressed in milliseconds, of the affected sound range.

nEndPosition

End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound.

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)
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.