Skip to content

Commit 49baefe

Browse files
authored
Update README.md
1 parent 2eead02 commit 49baefe

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
<p align="center">
2020
<a href="#features">Features</a> •
2121
<a href="#installation">Installation</a> •
22+
<a href="#scripting--ipc-apis">Scripting/API</a> •
2223
<a href="#contributors">Contributors</a> •
2324
<a href="#license">License</a>
2425
</p>
@@ -83,13 +84,8 @@ ____________
8384
**Designed for use with PipeWire. PulseAudio is only supported for backward compatibility.**
8485

8586
PipeWire has a much lower latency compared to PulseAudio when injecting audio effects processors into the audio graph.
86-
8787
I'm currently not planning to add more advanced support for Pulseaudio clients. Features such as selective app exclusion, changing the target audio device, and similar features will only be available to PipeWire clients.
8888

89-
*Important: This application can be either compiled with PulseAudio or PipeWire support. Please make sure you choose the correct flavor for your Linux setup before installing!*
90-
91-
*Note: PipeWire's compatibility mode for PulseAudio apps does not work with the PulseAudio flavor of this app. Use the version for PipeWire instead.*
92-
9389
### Which one am I using?
9490

9591
Follow the instructions below if you don't know which one your Linux distribution is using. If you already know, skip to the 'Install dependencies' section.
@@ -307,6 +303,46 @@ Download icon
307303
```bash
308304
sudo wget -O /usr/share/pixmaps/jamesdsp.png https://raw.githubusercontent.com/Audio4Linux/JDSP4Linux/master/resources/icons/icon.png -q --show-progress
309305
```
306+
## Scripting & IPC APIs
307+
308+
Since 12th May 2023, this app supports IPC via D-Bus and is also configurable via a CLI. These new features are not yet included in a stable release.
309+
310+
### Remote control via CLI
311+
You can list all supported commands using `jamesdsp --help`.
312+
Currently, these commands for remote-controlling JamesDSP's audio engine are available:
313+
```
314+
--is-connected Check if JamesDSP service is active. Returns
315+
exit code 1 if not. (Remote)
316+
--list-keys List available audio configuration keys (Remote)
317+
--get <key> Get audio configuration value (Remote)
318+
--set <key=value> Set audio configuration value (format:
319+
key=value) (Remote)
320+
--load-preset <name> Load preset by name (Remote)
321+
--save-preset <name> Save current settings as preset (Remote)
322+
--delete-preset <name> Delete preset by name (Remote)
323+
--list-presets List presets (Remote)
324+
--status Show status (Remote)
325+
```
326+
The options should be fairly self-explanatory. For example, `jamesdsp --set reverb_enable=true` would enable the reverberation setting.
327+
328+
Note: These commands try to connect to an active JamesDSP instance. If no instance is currently online, they will fall-back to modifying the audio configuration file directly on disk. The `--is-connected` option can be used to check whether one is currently online.
329+
330+
### D-Bus IPC
331+
332+
This app also exposes a D-Bus service on the session bus which can be used by other developers or users:
333+
334+
Service name: `me.timschneeberger.jdsp4linux`
335+
* GUI-related interface:
336+
* Path name: `/jdsp4linux/gui`
337+
* Interface name: `me.timschneeberger.jdsp4linux.Gui`
338+
* Description:
339+
* Audio service-related interface:
340+
* Path name: `/jdsp4linux/service`
341+
* Interface name: `me.timschneeberger.jdsp4linux.Service`
342+
343+
If you want to test it out, you can use an app like [D-Feet](https://wiki.gnome.org/Apps/DFeet) to interact with the D-Bus services.
344+
345+
The D-Bus introspection XML is available here: https://github.com/Audio4Linux/JDSP4Linux/blob/master/src/utils/dbus/manifest.xml.
310346

311347
## Troubleshooting
312348
* Your CPU may be too slow to process the audio sample in time; try to disable some effects (especially resource-hungry ones like the convolver)

0 commit comments

Comments
 (0)