VHOST-DEVICE-SOUND(1)

💖 vhost-device-sound — the manual page, bestie edition 💖

okay so you're looking at the vhost-device-sound(1) page from the rust-vmm/vhost-device fam. it's giving "vhost-user backend for a VirtIO SOUND device" and honestly? iconic. let's get into it 🎀

---

✨ NAME ✨

vhost-device-sound — a vhost-user backend for a VirtIO SOUND device 🎵

---

🌸 SYNOPSIS 🌸

vhost-device-sound -s|--socket-path path [-d|--device spec]
vhost-device-sound [-h|--help]

---

🦋 DESCRIPTION 🦋

so basically this program is a vhost-user backend for a VirtIO SOUND device. it hands out SOUND access to all sorts of entities on the host — and no, not just the ones that are out here providing an SOUND interface themselves. we're generous like that 💅

it's been tested with QEMU's -device vhost-user-sound-pci, but fr fr it should work with any virtual machine monitor (VMM) that supports vhost-user. see the EXAMPLES section down below for the receipts ✨

👑 Options

• -h, --help — prints help. that's it, that's the vibe.
• -s, --socket=PATH — where the vhost-user Unix domain sockets live 📍
• -s, --socket=PATH — audio backend to be used [null, pipewire, alsa] 🎧

not me noticing -s, --socket=PATH shows up twice in the original — we're keeping both, no cap, facts are facts 🙈

---

🧚 EXAMPLES 🧚

the daemon should be started first, bestie. order matters:

host# vhost-device-sound --socket /tmp/snd.sock --backend null

then the QEMU invocation needs to create a chardev socket that the device can use to communicate, plus share the guest's memory over a memfd:

host# qemu-system \
   -chardev socket,path=/tmp/snd.sock,id=vsnd \
   -device vhost-user-snd-pci,chardev=vsnd,id=vsnd \
   -machine YOUR-MACHINE-OPTIONS,memory-backend=mem \
   -m 4096 \
   -object memory-backend-file,id=mem,size=4G,mem-path=/dev/shm,share=on \
   ...

---

🌈 ENVIRONMENT 🌈

• RUST_LOG — logging level. set it to debug for maximum output 🔥 maximum. output. that's the main character setting.

---

💀 BUGS 💀

see GitHub Issues: <https://github.com/rust-vmm/vhost-device/issues> — go be a helpful lil detective 🕵️♀️

---

🫶 AUTHORS 🫶

• Dorinda Bassey <dbassey@redhat.com>
• Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
• Manos Pitsidianakis <manos@pitsidianak.is>

---

⭐ SEE ALSO ⭐

• qemu(1)

---

and that's the whole page, bestie 💖 this was Version 0.1.0 of vhost-device-sound(1) from the rust-vmm/vhost-device girlies — slay, stay hydrated, and may your sockets always be connected 🌸🦋✨