libpipewire-module-example-sink(7) Miscellaneous Information Manual libpipewire-module-example-sink(7)

# [NAME](#NAME)

libpipewire-module-example-sink - Example Sink

# [DESCRIPTION](#DESCRIPTION)

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

We refer to the source code for more information.

# [MODULE NAME](#MODULE_NAME)

libpipewire-module-example-sink

# [MODULE OPTIONS](#MODULE_OPTIONS)

- 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

# [GENERAL OPTIONS](#GENERAL_OPTIONS)

Options with well-known behavior.

- **remote.name**
- **audio.format**
- **audio.rate**
- **audio.channels**
- **audio.layout**
- **audio.position**
- **media.name**
- **node.latency**
- **node.name**
- **node.description**
- **node.group**
- **node.virtual**
- **media.class**

# [EXAMPLE CONFIGURATION](#EXAMPLE_CONFIGURATION)

```
# ~/.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.6.11 PipeWire

---

Document: libpipewire-module-example-sink(7) from pipewire 1.6.11-r2 (Chainguard OS)
Source: https://gitlab.freedesktop.org/pipewire/pipewire