Appendix > Appendix F - FdkAac encoder command line

Remarks

Applies a Chorus effect to the given portion of sound under editing. This method is not available for COM interoperability: in alternative you can use the Effects.DirectXApplyChorus method.

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 DirectXApply (

nStartPosition as Int32,

nEndPosition as Int32,

fx as Microsoft.DirectX.DirectSound.EffectsChorus

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXApply (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft.DirectX.DirectSound.EffectsChorus fx

);

[C++]

public: enumErrorCodes DirectXApply (

Int32 nStartPosition,

Int32 nEndPosition,

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

Delay	Retrieves and sets the number of milliseconds the input is delayed before it is played back. Can range from ChorusEffect.DelayMin to ChorusEffect.DelayMax. The default value is 16 ms.
Depth	Retrieves and sets the percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Can range from ChorusEffect.DepthMin to ChorusEffect.DepthMax. The default value is 10.
Feedback	Retrieves and sets the percentage of output signal to feed back into the effect's input. Can range from ChorusEffect.FeedbackMin to ChorusEffect.FeedbackMax. The default value is 25.
Frequency	Retrieves and sets the frequency of the LFO Can range from ChorusEffect.FrequencyMin to ChorusEffect.FrequencyMax. The default value is 1.1.
Phase	Retrieves and sets the phase differential between left and right LFOs Can range from ChorusEffect.PhaseMin to ChorusEffect.PhaseMax. Can be set by the one values below: - ChorusEffect.PhaseZero - ChorusEffect.Phase90 - ChorusEffect.PhaseNegative90 - ChorusEffect.Phase180 - ChorusEffect.PhaseNegative180 The default value is ChorusEffect.Phase90.
Waveform	Retrieves and sets the waveform shape of the LFO Can be set by the one values below: - ChorusEffect.WaveSin - ChorusEffect.WaveTrianlge The default value is ChorusEffect.WaveSin.
WetDryMix	Retrieves and sets the ratio of wet (processed) signal to dry (unprocessed) signal Can range from ChorusEffect.WetDryMixMin to ChorusEffect.WetDryMixMax. The default value is 50.

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.