Set Server to None by RPC

[anprdev]

I don't know if it is possible to Set the server to None with the Json- Rpc

We can get all Directory's so maybe it is possible to also add something like
jamulusserver/setDirectory

This way you can set the directory to None if you like to play private.

[ann0see]

I would assume that this can be implemented - but this could require some hop arounds if we want that the gui stays in sync (which is a requirement to get accepted to production).

The currently supported methids are here:
https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md

[pljones]

No, the Server name should never be empty if the Server is registering with a Directory. If it isn't, then set it on the command line to whatever you want. Directories should prevent servers without a name registering, really.

[ann0see]

I believe he means that there should be a way to unregister from a directory

[anprdev]

Let me explain
My Music player now also has a option to use the player as jammer.
Jammer option.
User Login and is in that case a Bandleader with control and see the Player Buttons on the Web page.
Nobody else has control and don't see the Player Button's
The Player give this Bandleader to control the Audio Player. Only he can do that.
The idea is, to set the Server to Private as all Band members are there.
Like jamulusserver/setDirectory("None") and back if jamming is done and server is running as a Player again.
Like jamulusserver/setDirectory("Any Genre 1")
Still busy with the Player Control at the moment only option is to Mute Tracks.
Mute tracks in that case Mute the selected Track for all users.

My way to do this is, if there is a command like jamulusserver/setDirector(0) then select the first entry in the Directory box and that is None.
jamulusserver/setDirector(1) select the first Directory and that is Any Genre 1. ComboBox event will be triggered I think.
Something like ComboBox.selectedIndex = 0 or 1, 2, 3 etc
I think this has to be possible in GUI Mode I always using.
CLI mode I don't know.

Anymore questions just ask.
Happy to explain more.

[anprdev]

Bandleader is the person who has control over the Audio Player at the moment he is logged in..

Jammer is that the Player is in Jam Mode. Some settings of the Player will change and is control by the Bandleader in that case.
This until he is logged out from the website or from Jamulus

[pljones]

This doesn't sound like Jamulus to me. These aren't standard features.

[anprdev]

I use the standard Jamulus Server.
On the Jamulus Server there 5 Jamulus Clients connected as default. see Image1
Tracks are Original, Bass, Drums, Vocal and Others. Users can mute this tracks in Bandmode.
This will Mute the selected Track for all User loged in.
In Auto mode the users also can Mute tracks but then From the Client and only for them self.

Nothing has to change in Jamulus except if possible the option to set the Server to None Directory or Select a directory by RPC.

The meaning is the Users can Jam with the songs in the Song Table and this from the website.
Also can put songs in the Wishlist what will be played next.

Change the Directory for the Jamulus Server is to use when all Band Members are login in Jamulus and Like to Jam together,
The Server can then be set to private if needed.

Many users stay short or long on the server and play with the songs to practice or just Jam.

I hope this explaining more.
If you like to check it out be my guest. Blues/Rock server in any Genre 1.

Website in auto mode

Website in Jam Mode

Jamulus Client

[pljones]

OK, right - so nothing to do with "Set Server to None by RPC" -- you want to have the server unregistered from its directory, like you can through the server UI?

[anprdev]

Yes and also set it back to a directory like any genre 1 or a other.

I was thinking that can be done with Json- RPC.
A Extra command for the Server can be nice.
Like jamulusserver/setDirectory("None") and back if jamming is done and server is running as a Player again.
Like jamulusserver/setDirectory("Any Genre 1")
Reason is that when the Band is complete the Bandleader has the choice to set the Server to Private or not.
Sorry if I was not clear with my question and answers.

[pljones]

PR with proposed fix #3533

[anprdev]

@pljones Can I somehow also test this for Windows and Linux?
macOS I don't know if this is working in a VM I have.

Nice to see others also like that idea. @rdica

@chrisrimple Enjoy your traveling.

[ann0see]

Yes. Go to the "Checks" tab of the PR. There are "artifacts" you can download and install.

[anprdev]

Sorry that I can not find that Tab Checks.

[rdica]

@anprdev https://github.com/jamulussoftware/jamulus/pull/3533/checks
There's a pulldown menu at the top of that page called Artifacts that you can use to download pkgs for the various OSs.

[anprdev]

Top Thanks

[anprdev]

Shame missing the arm version for Raspberry Pi aarch64

old version 3.11 was jamulus_3.11.0_ubuntu_armhf.deb

[ann0see]

We can probably kick off building one.

[pljones]

It'll be here: https://github.com/pljones/jamulus/actions/runs/17557282994

• jamulus-headless_3.11.0dev-a0f38c9_ubuntu_armhf.deb

(All green. I couldn't work out how to respin the PR build once I'd change to All targets. Is that even possible?)

[rdica]

@pljones Yesterday when I was testing functionality I saw what I thought may be inconsistencies in the output of RPC method jamulusserver/getServerProfile.

directory, directoryAddress, and directoryType fields only seem to be populated based on how the server was started, or disconnected, or directory server changed on the fly via RPC.

If I understand the output correctly, directoryAddress field will only be populated when given on the commandline, or when provided via RPC jamulusserver/setDirectory param directoryAddress.

directoryType will either be custom if directoryAddress is specified on commandline or provided via RPC jamulusserver/setDirectory param directoryAddress.
If one of the official directories is used in an RPC-based move, directoryType will reflect jamulus internal var name defined as EDirectoryType in src/serverrpc.cpp.
Or none if not connected to a directory server.

directory always populated with full server:port (anygenre1 notwithstanding as default port is 22124 and not passed with the host to connect with), unless not connected.

Before I update/add the new RPC functionality to my scripts, could you please confirm the outputs as expected behaviour, thanks.

# From Linux service unit:
# ExecStart=/home/jam/bin/jamulus-3.12.0beta1 --directoryaddress anygenre2.jamulus.io:22224 \
# --serverinfo  "RPC Test;'merka ehyup;us" \
# -6 --server --nogui --discononquit -p 11111 \
# --welcomemessage "RPC Test" --numchannels 2 \
# --jsonrpcport 11124 --jsonrpcsecretfile /data/jamulus/rpcfile \
# -R /data/jamulus/recordings --norecord -l /data/jamulus/logs/jamulus-test.log -T -P
{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "'merka ehyup",
    "countryId": 225,
    "directory": "anygenre2.jamulus.io:22224",
    "directoryAddress": "anygenre2.jamulus.io:22224",
    "directoryType": "custom",
    "name": "RPC Test",
    "registrationStatus": "registered",
    "welcomeMessage": "RPC Test"
  }
}

# RPC call to change from anygenre2 to any_genre_3
{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "'merka ehyup",
    "countryId": 225,
    "directory": "anygenre3.jamulus.io:22624",
    "directoryAddress": "",
    "directoryType": "any_genre_3",
    "name": "RPC Test",
    "registrationStatus": "registered",
    "welcomeMessage": "RPC Test"
  }
}

# RPC call disconnect from directory server
{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "'merka ehyup",
    "countryId": 225,
    "directory": "",
    "directoryAddress": "",
    "directoryType": "none",
    "name": "RPC Test",
    "registrationStatus": "not_registered",
    "welcomeMessage": "RPC Test"
  }
}

# RPC call connect to genre_choral_barbershop after disconnect
{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "'merka ehyup",
    "countryId": 225,
    "directory": "choral.jamulus.io:22724",
    "directoryAddress": "",
    "directoryType": "genre_choral_barbershop",
    "name": "RPC Test",
    "registrationStatus": "registered",
    "welcomeMessage": "RPC Test"
  }
}

# After RPC disconnect, RPC connect to private directory server
{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "'merka ehyup",
    "countryId": 225,
    "directory": "localhost:42924",
    "directoryAddress": "localhost:42924",
    "directoryType": "custom",
    "name": "RPC Test",
    "registrationStatus": "registered",
    "welcomeMessage": "RPC Test"
  }
}

[rdica]

👍 Ok thanks!

[pljones]

directory always populated with full server:port (anygenre1 notwithstanding as default port is 22124 and not passed with the host to connect with), unless not connected.

So you tested with Jamulus -s with no specified directory? Could you post the response for that? (I've got a directory running on that port, so I can't test it locally.)

[pljones]

Also, have you tried setting directoryAddress to localhost (with no port)? That should turn your server into a directory -- but most of that set up happens once at start up, so I'd bet it does no such thing.

That's another thing that'll need a separate issue.

[rdica]

Seems to have worked.

Starting without a directory server specified, using port 11111:

{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "RPC Test",
    "countryId": 225,
    "directory": "",
    "directoryAddress": "",
    "directoryType": "none",
    "name": "RPC Test",
    "registrationStatus": "not_registered",
    "welcomeMessage": "RPC Test"
  }
}

I then set directoryAddress to localhost with no port, RPC call return result was {"id":"change_directory","jsonrpc":"2.0","result":"ok"}

The following is from Jamulus app stdout:

- JSON-RPC: received connection from: "127.0.0.1"
- JSON-RPC: accepted valid authentication secret from "127.0.0.1"
Now a directory
Server Registration Status update: Registered
- JSON-RPC: connection from: "127.0.0.1" closed

getServerProfile output after the above:

{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "RPC Test",
    "countryId": 225,
    "directory": "localhost",
    "directoryAddress": "localhost",
    "directoryType": "custom",
    "name": "RPC Test",
    "registrationStatus": "registered",
    "welcomeMessage": "RPC Test"
  }
}

I started a server pointing --directoryaddress localhost:11111 and it registered.

- Starting in server mode by default (due to compile time option)
- server info: RPC Test;RPC Test;us
- server mode chosen
- no GUI mode chosen
- disconnect all clients on quit
- selected port number: 12111
- welcome message: RPC Test
- maximum number of channels: 2
- JSON-RPC port number: 12124
- JSON-RPC secret file: /data/jamulus/rpcfile
- recording directory name: /data/jamulus/recordings
- recording will not take place until enabled
- logging file name: /data/jamulus/logs/jamulus-test.log
- using multithreading
- starting with delay panning
- register with directory at address: localhost:11111
- JSON-RPC: This interface is experimental and is subject to breaking changes even on patch versions (not subject to semantic versioning) during the initial phase.
- JSON-RPC: Server started on 127.0.0.1:12124
Using "192.168.50.12" as external IP.
Using server info: name = "RPC Test", city = "RPC Test", country/region = "us" (United States)
Recording state: disabled
found only one core, disabling multithreading
 *** Jamulus, Version 3.12.0beta1
 *** Internet Jam Session Software
 *** Released under the GNU General Public License version 2 or later (GPLv2)
 *** <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
 *** 
 *** This program is free software; you can redistribute it and/or modify it under
 *** the terms of the GNU General Public License as published by the Free Software
 *** Foundation; either version 2 of the License, or (at your option) any later version.
 *** There is NO WARRANTY, to the extent permitted by law.
 *** 
 *** This app uses the following libraries, resources or code snippets:
 *** 
 *** Qt cross-platform application framework 5.15.13 (build), 5.15.13 (runtime)
 *** <https://www.qt.io>
 *** 
 *** Opus Interactive Audio Codec
 *** <https://www.opus-codec.org>
 *** 
 *** Copyright © 2005-2024 The Jamulus Development Team

Server Registration Status update: Registration requested
Server Registration Status update: Registered

I repeated the second step using a different port (15111) than the one I specified at startup 11111:

{
  "id": "full_profile",
  "jsonrpc": "2.0",
  "result": {
    "city": "RPC Test",
    "countryId": 225,
    "directory": "localhost:15111",
    "directoryAddress": "localhost:15111",
    "directoryType": "custom",
    "name": "RPC Test",
    "registrationStatus": "time_out",
    "welcomeMessage": "RPC Test"
  }
}

# stdout:
- JSON-RPC: received connection from: "127.0.0.1"
- JSON-RPC: accepted valid authentication secret from "127.0.0.1"
Server Registration Status update: Registration requested
- JSON-RPC: connection from: "127.0.0.1" closed
Server Registration Status update: Registration failed

[pljones]

Nice! Thanks for that.

[anprdev]

Now I wondering how to Call jamulusserver/setDirectory("??????") what Parameter is used for the GUI version.
Must this be the full URL? "anygenre2.jamulus.io:22224"
And what to send to unregistered the directory just empty."" ?

[ann0see]

I think unregistering means setting directory type to "none". But check the docs/ JSON-RPC.md file.

[anprdev]

Top Many thanks. have not seen that this was changed Sorry.

[anprdev]

In GUI
This is working I can change the Directory but when I send none to unregister the Directory Any Genre 1 text stays and Not Registered is shown.
Wondering if the Combo Box also has to change the Value to None.
If I send None the Box change to Any Genre 1 and is still registered.
Sending none then no matter of Directory I have select the Directory get Not Registered and the Box has the selected Directory.
Has the Directory Box not also to change to None to Prevent confusions?
JSON Show
{
"id": null,
"jsonrpc": "2.0",
"result": {
"city": "Zwolle",
"countryId": 151,
"directory": "",
"directoryAddress": "",
"directoryType": "none",
"name": "Blues/Rock",
"registrationStatus": "not_registered"

}

[anprdev]

For the GUI,
Can this not be done with set the DirectoryBox.selectedindex = 0?
Just a idea.

[pljones]

No.

That's not how the application code works.

Only the GUI code has access to the widgets.

Unfortunately, the GUI doesn't expect anything to be updating these values currently.

So that's why changing the GUI isn't a small piece of work. It needs doing for all the values that could be changed via RPC and done in a way so that changing via the GUI doesn't cause a loop.

The same applies in the client, I think.

[anprdev]

@pljones If that is so then better not to make this changes needed for the GUI.
Waste of time.

[pljones]

We have it on our "stuff that should work but doesn't and isn't easy to fix" list...

[anprdev]

Nice working I test it on my Raspberry Pi.
Checkbox checked and Server is Not registered.
Uncheck and the Server is registered.
This CheckBox will be control by the website when finish.
Will be very nice and happy users.