Copyright © 2005-2018 MultiMedia Soft

Effects.EchoApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies an echo effect on the playing song. This effect can be reset through the Effects.EchoReset method.

 

This is an echo effect that replays what you have played one or more times after a period of time. It's something like the echoes you might hear shouting against a canyon wall. For reverb effect enable feedback.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

Public Function EchoApply (

nPlayerIndex as Int16,

nAffectedChannel as enumChannelMasks,

fDryMix as Single,

fWetMix as Single,

fFeedback as Single,

fDelay as Single,

bStereo as Boolean,

nPriority as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes EchoApply (

Int16 nPlayerIndex,

enumChannelMasks nAffectedChannel,

float fDryMix,

float fWetMix,

float fFeedback,

float fDelay,

bool bStereo,

Int16 nPriority

);


 

[C++]

public: enumErrorCodes EchoApply (

Int16 nPlayerIndex,

enumChannelMasks nAffectedChannel,

float fDryMix,

float fWetMix,

float fFeedback,

float fDelay,

bool bStereo,

Int16 nPriority

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nAffectedChannel

Numeric value that determines the combination of affected channels.

Supported values are the following:

Mnemonic constant

Value

Meaning

CHANNEL_MASK_0

1 (0x01)

Channel 0 or left channel

CHANNEL_MASK_1

2 (0x02)

Channel 1 or right channel

CHANNEL_MASK_2

4 (0x04)

Channel 2

CHANNEL_MASK_3

8 (0x08)

Channel 3

CHANNEL_MASK_4

16 (0x10)

Channel 4

CHANNEL_MASK_5

32 (0x20)

Channel 5

CHANNEL_MASK_6

64 (0x40)

Channel 6

CHANNEL_MASK_7

128 (0x80)

Channel 7

CHANNEL_MASK_LEFTS

85 (0x55)

All left channels

CHANNEL_MASK_RIGHTS

170 (0xAA)

All right channels

CHANNEL_MASK_ALL

255 (0xFF)

All available channels

fDryMix

Numeric value representing the Dry (unaffected) signal mix.

Supported values are in the range from -2 to +2.

fWetMix

Numeric value representing the Wet (affected) signal mix.

Supported values are in the range from -2 to +2.

fDelay

Numeric value representing the delay expressed in seconds.

Supported values are in the range from -1 to +1.

bStereo

Boolean value, only allowed with even number of channels, instructs the effect to affect both stereo channels or only single channels.

Supported values are the following:

Mnemonic constant

Meaning

false

Affect single channels only

true

Affect both stereo channels

nPriority

Effect's priority level inside the chain of DirectX effects, custom DSP effects and VST effects. Effects with higher priority are applied before effects with lower priority; in case more effects should have the same priority, they would be invoked in the same order that they were added.

 

The fDryMix is the volume of input signal and the fWetMix is the volume of delayed signal. The fDelay is the delay time in sec. The fFeedback sets how much delay is feed back to the input (for repeating delays). If bStereo is enabled and a stream has an even number of channels then, each even channels will be echoed to each other.

 

Below some sample:

 


fDryMix

fWetMix

fFeedback

fDelay

Small Echo

0.999

0.999

0.0

0.20

Many Echoes

0.999

0.999

0.7

0.50

Reverse Echoes

0.999

0.999

-0.7

0.80

Robotic Voice

0.500

0.800

0.5

0.10

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

enumErrorCodes.NOERROR (0)

The method call was successful.