EchoSoundEffect
Adds delayed repetitions of a sound with diminishing volume.
| Memory category | Instances |
|---|
Member index 4
Description
An echo effect causes a sound to repeat on a delay with diminishing volume, simulating the real effect of an echo. This effect can be applied to either an individual sound or to a sound group by parenting it to the desired instance.
The effect is controlled by several properties. First, the Delay is how long the effect will wait to play the echoed sound. Feedback determines how much the original signal is diminished to play as the echoed sound. Note that this echoed sound also goes through the echo effect which will wait another delay and play another echo. This process will repeat until the volume of the echoed sound is negligible.
You can also adjust the wet/dry mix of the effect. The dry component of the sound is the original sound that the effect is being applied to. You can adjust the volume of the dry sound by adjusting the DryLevel. The wet sound is the echoed effect itself, and its volume can be adjusted with WetLevel.
It is recommended to only use the EchoSoundEffect with sound groups. If an echo effect is applied to a regular Sound, once that sound stops playing the echo effect will also be cut off. When applied to a SoundGroup, the echo effect will continue playing even if the original source sound has stopped.Like all other SoundEffect, a EchoSoundEffect can be applied either to a Sound or SoundGroup by being parented to either.
History 21
- 726 Change Default of WetLevel from 0 to
- 726 Change Default of Feedback from 0.5 to
- 726 Change Default of DryLevel from 0 to
- 726 Change Default of Delay from 1 to
- 553 Change Default of WetLevel from to 0
- 553 Change Default of Feedback from to 0.5
- 553 Change Default of DryLevel from to 0
- 553 Change Default of Delay from to 1
- 486 Change ThreadSafety of WetLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Feedback from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DryLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Delay from ReadOnly to ReadSafe
- 462 Change ThreadSafety of WetLevel from to ReadOnly
- 462 Change ThreadSafety of Feedback from to ReadOnly
- 462 Change ThreadSafety of DryLevel from to ReadOnly
- 462 Change ThreadSafety of Delay from to ReadOnly
- 264 Add WetLevel
- 264 Add Feedback
- 264 Add DryLevel
- 264 Add Delay
- 264 Add EchoSoundEffect
Members 4
Delay
| Type | Default | |
|---|---|---|
| float | ||
Range: 0.01 to 5 (default 1) The amount of time between echoes. Measured in seconds.
If a EchoSoundEffect is applied to a singular sound instead of a sound group, if the sound stops playing before the delay causes an echo, the echo will not play. Because of this, it is recommended to apply echo effects to SoundGroups and not Sounds.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
DryLevel
| Type | Default | |
|---|---|---|
| float | ||
Range: -80 to 10 (default 0) The output volume of the original sound.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Feedback
| Type | Default | |
|---|---|---|
| float | ||
Range: 0 to 1 (default 0.5) The echo decay every time the echo plays. Setting this at it's minimum (0) will cause no feedback, meaning the echo won't be audible at all. Setting this at the maximum (1) will have no decay, meaning the echoed sound will play at the level of the original and will not diminish over time.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
WetLevel
| Type | Default | |
|---|---|---|
| float | ||
Range: -80 to 10 (default 0) The output volume of the echoed effect.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |