Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document JSON-RPC API #909

Merged
merged 4 commits into from
Mar 27, 2023
Merged

Document JSON-RPC API #909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c52b9bf
Document JSON-RPC API in user and server manuals
ann0see Mar 26, 2023
9425fbe
Remove "fine grained"
ann0see Mar 26, 2023
190f724
Fix typo
ann0see Mar 26, 2023
55ea1fe
Rewording
ann0see Mar 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion wiki/en/Running-a-Server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,10 @@ Start the Jamulus Server graphical user interface in the minimized window state.

{% include_relative Include-Shared-Commands.md %}

### Controlling the Server via API

Jamulus can be controlled via an experimental API which is subject to changes. You can find the [JSON-RPC API documented in the main repository](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md). JSON-RPC allows you to control some features like changing the welcome message or starting recordings in headless mode from authenticated external applications. It works while the server is running.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"changing some features" sounds wordy.


---

## Recording
Expand All @@ -246,7 +250,8 @@ Set server not to record by default when recording is configured.

Recording starts once the first person connects to the Server, and stops when the last person leaves.

If the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new directory. SIGUSR2 will toggle recording on/off.
If the Server receives a SIGUSR1 signal during a recording, it will start a new recording in a new directory. SIGUSR2 will toggle recording on/off. If [JSON-RPC](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md) is enabled, you will also be able to manage the server in a way comparable to the GUI. Please see the (experimental) [JSON-RPC documentation on the recorder](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md#jamulusserverstartrecording).


To send these signals using systemd, create the following two `.service` files in `/etc/systemd/system`, calling them something appropriate (e.g. `jamulusTogglerec.service`).

Expand Down
3 changes: 2 additions & 1 deletion wiki/en/Software-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,5 +302,6 @@ For macOS, start a Terminal window and run Jamulus with the desired options like

{% include_relative Include-Shared-Commands.md %}

# Controlling the Client via API


In addition to the CLI, Jamulus can be controlled using an API. This is beneficial for advanced use cases - for example, where there is no GUI, or another application needs to interact with Jamulus. Please note that the API is still experimental. Information on the [JSON-RPC API can be found in the main repository](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md).