audioecho

audioecho adds an echo or (simple) reverb effect to an audio stream. The echo delay, intensity and the percentage of feedback can be configured.

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 sound.

Use the max-delay property to set the maximum amount of delay that will be used. This can only be set before going to the PAUSED or PLAYING state and will be set to the current delay by default.

audioecho can also be used to apply a configurable delay to audio channels by setting surround-delay=true. In that mode, it just delays "surround channels" by the delay amount instead of performing an echo. The channels that are configured surround channels for the delay are selected using the surround-channels mask property.

Example launch lines

 gst-launch-1.0 autoaudiosrc ! audioconvert ! audioecho delay=500000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
 gst-launch-1.0 filesrc location="melo1.ogg" ! decodebin ! audioconvert ! audioecho delay=50000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
 gst-launch-1.0 audiotestsrc ! audioconvert ! audio/x-raw,channels=4 ! audioecho surround-delay=true delay=500000000 ! audioconvert ! autoaudiosink

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseTransform
                    ╰──GstAudioFilter
                        ╰──audioecho

Factory details

Authors: – Sebastian Dröge

Classification:Filter/Effect/Audio

Rank – none

Plugin – audiofx

Package – GStreamer Good Plug-ins

Pad Templates

sink

audio/x-raw:
         format: { F32LE, F64LE }
           rate: [ 1, 2147483647 ]
       channels: [ 1, 2147483647 ]
         layout: interleaved

Presencealways

Directionsink

Object typeGstPad


src

audio/x-raw:
         format: { F32LE, F64LE }
           rate: [ 1, 2147483647 ]
       channels: [ 1, 2147483647 ]
         layout: interleaved

Presencealways

Directionsrc

Object typeGstPad


Properties

delay

“delay” guint64

Delay of the echo in nanoseconds

Flags : Read / Write

Default value : 1


feedback

“feedback” gfloat

Amount of feedback

Flags : Read / Write

Default value : 0


intensity

“intensity” gfloat

Intensity of the echo

Flags : Read / Write

Default value : 0


max-delay

“max-delay” guint64

Maximum delay of the echo in nanoseconds (can't be changed in PLAYING or PAUSED state)

Flags : Read / Write

Default value : 1


surround-delay

“surround-delay” gboolean

Delay Surround Channels when TRUE instead of applying an echo effect

Flags : Read / Write

Default value : false


surround-mask

“surround-mask” guint64

A bitmask of channels that are considered surround and delayed when surround-delay = TRUE

Flags : Read / Write

Default value : 18446744073709551612


The results of the search are