DOKK / manpages / debian 13 / libpipewire-0.3-modules / libpipewire-module-example-sink.7.en
libpipewire-module-example-sink(7) Miscellaneous Information Manual libpipewire-module-example-sink(7)

libpipewire-module-example-sink - Example Sink

The example sink is a good starting point for writing a custom sink.

We refer to the source code for more information.

libpipewire-module-example-sink

  • node.name: a unique name for the stream
  • node.description: a human readable name for the stream
  • stream.props = {}: properties to be passed to the stream

Options with well-known behavior.

  • remote.name
  • audio.format
  • audio.rate
  • audio.channels
  • audio.position
  • media.name
  • node.latency
  • node.name
  • node.description
  • node.group
  • node.virtual
  • media.class

# ~/.config/pipewire/pipewire.conf.d/my-example-sink.conf
context.modules = [
{   name = libpipewire-module-example-sink

args = {
node.name = "example_sink"
node.description = "My Example Sink"
stream.props = {
audio.position = [ FL FR ]
}
} } ]

1.4.2 PipeWire