Skip to content

Commit

Permalink
doc: inform how to use USB audio in disp-sys-audio
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-grande committed Jul 5, 2024
1 parent 1944091 commit a9ca2f0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 23 deletions.
36 changes: 16 additions & 20 deletions salt/sys-audio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Audio operations in Qubes OS.
* [Installation](#installation)
* [Usage](#usage)
* [Audio control](#audio-control)
* [Client switched it's AudioVM](#client-switched-its-audiovm)
* [Client started before it's AudioVM](#client-started-before-its-audiovm)
* [Client turned off with a device attached](#client-turned-off-with-a-device-attached)
* [How to use USB devices](#how-to-use-usb-devices)
* [How to use Bluetooth](#how-to-use-bluetooth)
Expand Down Expand Up @@ -62,30 +60,17 @@ sudo qubesctl --skip-dom0 --targets=tpl-sys-audio state.apply sys-audio.install-
### Audio control

The qube `disp-sys-audio` will be used for audio capabilities for speakers
and microphone, with builtin modules, Jack port or Bluetooth. You are be able
to control the volume via the volume icon that appears on the system tray.
and microphones, with builtin modules, Jack port, USB or Bluetooth. You are be
able to control the volume via the volume icon that appears on the system
tray.

Audio control basics:

* Left click toggles the volume; and
* Scrolling the mouse from left to right changes the volume;

For more advanced features, right click the icon and click on `Open Mixer` or
`Prefences`. For greater control, use the command `amixer`.

### Client switched it's AudioVM

If the client has already started when you decided to switch the AudioVM, you
will need to restart the client qube until [upstream issue is fixed](https://github.com/QubesOS/qubes-issues/issues/8975).

### Client started before it's AudioVM

Audio will not automatically connect if the AudioVM starts after the client.
To connect the client to audio server, restart the client's Pipewire service:

```sh
systemctl --user restart pipewire
```
`Preferences`. For greater control, use the command `amixer`.

### Client turned off with a device attached

Expand All @@ -99,7 +84,15 @@ will fail. To be able to use the device again:

### How to use USB devices

Please refer to the [usage of sys-usb](../sys-usb/README.md#usage).
It is possible to connect USB devices to `disp-sys-audio`, just attach the
devices to the AudioVM. Note that attached devices don't take precedence over
built-in audio. To choose which playback and recording device a qube should
use, on `disp-sys-audio`, from the application menu, click on `Volume Control`
or from the terminal, run `pavucontrol`. Select the `Playback` and `Recording`
tab, find your client qube and select the wanted device.

For more information, please refer to the
[usage of sys-usb](../sys-usb/README.md#usage).

### How to use Bluetooth

Expand All @@ -123,6 +116,9 @@ without first starting the backend holding the USB stack. You can move the
controller from the USB qube to the Audio qube, but this would decrease your
system security.

It may be easier to
[use the USB qube as the AudioVM instead](../sys-usb/README.md#usage).

First, start the qube holding the USB stack:

```sh
Expand Down
4 changes: 1 addition & 3 deletions salt/sys-usb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,7 @@ Bluetooth and Camera are normally integrated in laptops, but they still are
USB devices internally. They will be held by `(disp-)sys-usb` or
`(disp-)sys-net`, else `dom0`.

Built-in microphones on the other hand, are directly attached to `dom0`.

To use these devices, there are two options:
To use these devices, evaluate the following options:

1. Attaching the device (USB passthrough) to the audio client:
* Advantages:
Expand Down

0 comments on commit a9ca2f0

Please sign in to comment.