PipeWire  0.3.63
PipeWire Module: Echo Cancel

The echo-cancel module performs echo cancellation.

The module creates virtual echo-cancel-capture source and echo-cancel-playback sink nodes and the associated streams.

Module Options

Options specific to the behavior of this module

  • source.props = {}: properties to be passed to the source stream
  • sink.props = {}: properties to be passed to the sink stream
  • library.name = <str>: the echo cancellation library Currently supported: aec/libspa-aec-webrtc. Leave unset to use the default method (aec/libspa-aec-webrtc).
  • aec.args = <str>: arguments to pass to the echo cancellation method

General options

Options with well-known behavior:

Example configuration

1  context.modules = [
2  { name = libpipewire-module-echo-cancel
3  args = {
4  # library.name = aec/libspa-aec-webrtc
5  # node.latency = 1024/48000
6  source.props = {
7  node.name = "Echo Cancellation Source"
8  }
9  sink.props = {
10  node.name = "Echo Cancellation Sink"
11  }
12  }
13  }
14 ]