Davíð Steinn Geirsson 1ca3fc766c sound: document --streams CLI option in README

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-17 19:33:57 +00:00

1.3 KiB

Raw Permalink Blame History

vhost-device-sound

Synopsis

   vhost-device-sound --socket <SOCKET> --backend <BACKEND>

Description

   A virtio-sound device using the vhost-user protocol.

Options

     --socket <SOCKET>
            vhost-user Unix domain socket path

     --socket-fd <FD>
            listening vhost-user Unix domain socket file descriptor
            (e.g. from a service manager)

     --backend <BACKEND>
            audio backend to be used [possible values: null, pipewire, alsa, gstreamer]

     --streams <STREAMS>
            comma-separated list of stream directions to enable [possible values: output, input]
            (default: output,input)

     -h, --help
            Print help

     -V, --version
            Print version

Examples

Launch the backend on the host machine:

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

With QEMU, you can add a virtio device that uses the backend's socket with the following flags:

-chardev socket,id=vsnd,path=/tmp/snd.sock \
-device vhost-user-snd-pci,chardev=vsnd,id=snd

License

This project is licensed under either of

Apache License, Version 2.0
BSD-3-Clause License

1.3 KiB Raw Permalink Blame History