Skip to content
Snippets Groups Projects
Verified Commit a81ddbe2 authored by Ole Binder's avatar Ole Binder
Browse files

Docs: update README

add instructions on how to use the new auto-connect WirePlumber scripts
parent 9ef2db7c
No related branches found
No related tags found
1 merge request!8Feat jack support
...@@ -42,6 +42,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ...@@ -42,6 +42,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- PipeWire as the media server inside the docker container - PipeWire as the media server inside the docker container
- Docker compose support for easier building of local containers - Docker compose support for easier building of local containers
- WirePlumber script to automatically connect ports
- WirePlumber script to list device ports
### Removed ### Removed
......
...@@ -158,6 +158,8 @@ To start the server execute ...@@ -158,6 +158,8 @@ To start the server execute
make run make run
``` ```
### Connect Audio Device
Now connect your audio device(s) with engine-core. There are two ways to achieve this: Now connect your audio device(s) with engine-core. There are two ways to achieve this:
- use a UI like [qpwgraph](https://gitlab.freedesktop.org/rncbc/qpwgraph), simply draw connections between the desired devices - use a UI like [qpwgraph](https://gitlab.freedesktop.org/rncbc/qpwgraph), simply draw connections between the desired devices
...@@ -190,7 +192,50 @@ And start it with ...@@ -190,7 +192,50 @@ And start it with
docker compose up docker compose up
``` ```
Connect your audio device(s) with engine-core as mentioned above. Voilá, you should hear some music! Connect your audio device(s) with engine-core as mentioned [above](###Connect-Audio-Device). If you want engine-core to automatically connect your device every time you start it, you can also pass a device via the `.env` file to engine-core. For this you need the device alias and the channel names of your device. To get these run
```bash
docker compose run engine-core wpexec /etc/wireplumber/scripts/ls-ports.lua
```
This dumps details on every connected audio device. Grab the `port.alias` of your device and enter it in the `.env`. Press `CTRL + C` to exit the script.
<details>
<summary>Example Configuration</summary>
### Device Dump
```
{ ["audio.channel"] = AUX0,
["port.physical"] = true,
["port.alias"] = Yamaha AG06MK2:capture_AUX0,
["node.id"] = 61,
["format.dsp"] = 32 bit float mono audio,
["port.direction"] = out,
["port.name"] = capture_AUX0,
["port.terminal"] = true,
["object.serial"] = 324,
["object.id"] = 66,
["object.path"] = alsa:pcm:1:hw:1,0:capture:capture_0,
["port.id"] = 0,
}
```
### .env Settings
```bash
# Audio Device Settings
AURA_ENGINE_OUTPUT_DEVICE=Yamaha AG06MK2:capture
AURA_ENGINE_OUTPUT_CHANNEL_LEFT=AUX0
AURA_ENGINE_OUTPUT_CHANNEL_RIGHT=AUX1
AURA_ENGINE_INPUT_DEVICE=Yamaha AG06MK2:playback
AURA_ENGINE_INPUT_CHANNEL_LEFT=AUX0
AURA_ENGINE_INPUT_CHANNEL_RIGHT=AUX1
```
</details>
Voilá, you should hear some music!
## Advanced tips for development ## Advanced tips for development
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment