qusal/salt/sys-audio/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2023-11-13 09:33:28 -05:00
# sys-audio
Audio operations in Qubes OS.
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
2024-01-04 06:20:43 -05:00
* [Audio control](#audio-control)
* [Client started before sys-audio](#client-started-before-sys-audio)
* [Client turned off with a device attached](#client-turned-off-with-a-device-attached)
2023-11-13 09:33:28 -05:00
## Description
Creates the "sys-audio" qube for providing audio operations such as microphone
and speakers to and from qubes. By default, you can use wired USB audio, but
if you want, you can install the necessary packages for bluetooth with the
provided state.
## Installation
- Top
```sh
qubesctl top.enable sys-audio
2024-01-02 17:01:58 -05:00
qubesctl --targets=tpl-sys-audio,dvm-sys-audio state.apply
2023-11-13 09:33:28 -05:00
qubesctl top.disable sys-audio
```
- State
<!-- pkg:begin:post-install -->
```sh
qubesctl state.apply sys-audio.create
qubesctl --skip-dom0 --targets=tpl-sys-audio state.apply sys-audio.install
2024-01-02 17:01:58 -05:00
qubesctl --skip-dom0 --targets=dvm-sys-audio state.apply sys-audio.configure-dvm
2023-11-13 09:33:28 -05:00
```
<!-- pkg:end:post-install -->
If you need Bluetooth support:
```sh
qubesctl --skip-dom0 --targets=tpl-sys-audio state.apply sys-audio.install-bluetooth
```
## Usage
2024-01-04 06:20:43 -05:00
### Audio control
2023-11-13 09:33:28 -05:00
The qube `sys-audio` will be used for audio capabilities for speakers and
2024-01-04 06:20:43 -05:00
microphone, with builtin modules, Jack port or Bluetooth. You are be able to
2023-11-13 09:33:28 -05:00
control the volume via the volume icon that appears on the system tray.
2024-01-04 06:20:43 -05:00
The basics are very simple to use:
- 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 started before sys-audio
Audio will not automatically connect if sys-audio starts after the client. To
connect the client to audio server, restart the client's pipewire service:
```sh
systemctl --user restart pipewire
```
### Client turned off with a device attached
If you shutdown a client qube with a device attached, such as a microphone or
speaker, normal operation to attach the device to the same or any other qube
will fail. To be able to use the device again:
- Restart the audio server `sys-audio`;
- Restart the audio client; and
- Attach the device to the audio client;