Add note that audioecho's reverb sounds metallic
authorSebastian Dröge <sebastian.droege@collabora.co.uk>
Sat, 24 Jan 2009 10:53:40 +0000 (11:53 +0100)
committerSebastian Dröge <sebastian.droege@collabora.co.uk>
Sat, 24 Jan 2009 10:55:04 +0000 (11:55 +0100)
Add a note to the docs that audioecho's reverb will
sound metallic. This happens because for a real
reverb filter additional filtering is necessary.

Also note which values should be used for the delay
property to get an echo effect.

gst/audiofx/audioecho.c

index 04d5124..451506d 100644 (file)
  * SECTION:element-audioecho
  *
  * <refsect2>
- * audioecho adds an echo or reverb effect to an audio stream. The echo
+ * audioecho adds an echo or (simple) reverb effect to an audio stream. The echo
  * delay, intensity and the percentage of feedback can be configured.
  * <para>
+ * For getting an echo effect you have to set the delay to a larger value,
+ * for example 200ms and more. Everything below will result in a simple
+ * reverb effect, which results in a slightly metallic sounding.
+ * </para>
+ * <para>
  * <programlisting>
  * gst-launch filesrc location="melo1.ogg" ! audioconvert ! audioecho delay=500000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
  * gst-launch filesrc location="melo1.ogg" ! decodebin ! audioconvert ! audioecho delay=50000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink