LIBPIPEWIRE-MODULE-EXAMPLE-SINK(7)

✨ libpipewire-module-example-sink(7) ✨

okay bestie, welcome to the Miscellaneous Information Manual 🎀 — yes that's the manual section this lil page lives in, and it's section 7, the "miscellaneous" girlies. this is libpipewire-module-example-sink, and honestly? she's babygirl. periodt.

---

🌸 NAME 🌸

libpipewire-module-example-sink — Example Sink 💖

---

🦋 DESCRIPTION 🦋

so the example sink is a good starting point for writing a custom sink. she's the blueprint, the template, the moment before the glow-up. if you're building your own sink, start here fr fr.

and that's… kind of the whole description?? we literally refer to the source code for more information. the source code is the main character here, not this manpage, no cap 📖✨

---

👑 MODULE NAME 👑

libpipewire-module-example-sink

that's her. that's the whole entire name. iconic.

---

💅 MODULE OPTIONS 💅

these are the options this module takes, and you're gonna love them:

• node.name — a unique name for the stream. make it one-of-a-kind bestie, no duplicates allowed 💀
• node.description — a human readable name for the stream. this is the cute one humans actually see, so make it pretty 🎀
• stream.props = {} — properties to be passed to the stream. a whole little bag of goodies for the stream 🫶

---

🌈 GENERAL OPTIONS 🌈

these ones have well-known behavior, so they're like… the universally understood vibes. iykyk.

• 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

(she's a list, she's a legend, she's a moment ⭐)

---

🧚 EXAMPLE CONFIGURATION 🧚

put it here bestie 👇

# ~/.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 ]
        }
    }
}
]

look at her go 🥹 node.name, node.description, and a lil stream.props block with audio.position = [ FL FR ] — clean, simple, slay. copy it, tweak it, make it yours. the way that config file goes into ~/.config/pipewire/pipewire.conf.d/… obsessed 💖

---

💀 reminder: the source code is where the real tea is. this page said so itself. go read it.

---

and that's the whole page bestie!! 🎀✨ this was pulled from PipeWire version 1.6.11, as documented on the libpipewire-module-example-sink(7) page in the Miscellaneous Information Manual. go forth and build your sink, you absolute legend 💅🦋🌸