|JAMULUS(1)||General Commands Manual||JAMULUS(1)|
real-time collaborative music session
Jamulus, a low-latency audio client and
server, enables musicians to perform real-time “jam” sessions
over the internet. It is available across multiple platforms, so
participants of any field can communicate without specialist setup
requirements. This is not restricted to music, of course; other use (perhaps
conferencing?) is also possible.
One participant starts
Jamulus in Server
mode, ideally on a dedicated server (virtual) machine; all participants
start the (graphical) Client which transmits audio to the Server, receiving
back a mixed stream. Use of a metronome is recommended. Clients should be
connected using ethernet, not wireless, and use proper headphone and
microphone connections, not Bluetooth. The Server should run on a
low-latency system, ideally not a VM.
Jamulus without any extra options
launches the full graphical Client.
The options are as follows:
- enable IPv6 support
- (Client mode only) connect to the given Server address (hostname[:port]) at startup
- (Server mode only) disconnect all Clients on quit
- (Server mode only) Register the Server with the given Directory by setting
the Directory Server Address to use to hostname; see
-o; to be a Directory Server, use “
- (Server mode only) use 64 samples frame size mode, which reduces latency if Clients connect with “enable small network buffers” turned on; requires a faster CPU to avoid dropouts and uses more bandwidth to connected Clients
- (Server mode only) Set the path to a text file
containing an authentication string for obtaining access to the JSON-RPC
API. This option is required when
- (Server mode only) Enables JSON-RPC API server to control the application, set the TCP port number. This API is experimental and may change. It is only accessible from localhost. Please refer to the JSON-RPC API Documentation.
- (Directory mode only) whitelist which Servers are allowed to register on the server list; filter must consist of semicolon-separated IP addresses
- display a short help text and exit immediately
- (Client and non-headless Server mode only) override default initialisation file with file
- (Client mode only) do not automatically connect to JACK
- (Server mode only) require Clients to accept the agreement shown in the
welcome message (use
-wto set the text) before they are allowed joining
- (Server mode only) enable logging to file
- (Client mode only) start in muted state
- (Server mode only) write Server status and list of connected Clients, in HTML format, to file periodically
- disable the GUI
- (Registered Servers only) set Server location details, formatted as
;locale where locale is the numeric value of a
QLocale; see https://doc.qt.io/qt-5/qlocale.html#Country-enum for a list
- (Server mode only) start with delay panning enabled
- set the local UDP port to use to number (default: 22124)
- set QoS value (iptos byte) to use (default: 128)
- (Server mode only) enable recording (but see
--norecord) storing tracks in Directory
- start in Server mode
- (Server mode only) use multithreading to make better use of multi-core CPUs and support more Clients
- disable translations, use built-in English strings
- (Server mode only) set maximum number of channels (and, therefore, users); default is 10, maximum is 150
- display version information and exit immediately
- (Server mode only) show message (may contain HTML and inline CSS) to users on connect
- (Server mode only) start with minimised window
- (Server mode only) deprecated alias for
- (Client mode only) set window title and JACK client name
- (Client mode only) set MIDI controller channel to listen on, control
number offset and consecutive CC numbers (channels); format:
The first semicolon-separated element sets the MIDI channel
Jamuluslistens on for control messages. The other elements specify the items to control by their first literal letter (f = volume fader, p = pan, m = mute, s = solo) directly followed by the offset (CC number) to start from, a literal asterisk, and the amount of consecutive CC numbers to assign. Fader strips in the mixer window are controlled in ascending order from left to right.
Jamulusdoes not provide feedback as to the current state of the Solo and Mute buttons so the controller must track and signal their state locally.
- (Directory mode only) remember registered Servers even if the Directory is restarted
- (headless Client only) mute my channel in my personal mix
- (Server mode only) do not automatically start recording even if configured
- (Server mode only) configure Legacy IP address to bind to
- (Server mode only) configure public legacy IP address when both the Directory Server and the actual Server are situated behind the same NAT, so that Clients can connect
- (Client mode only) show all registered Servers in the serverlist regardless whether a ping to the Server is possible or not (debugging command)
- (Client mode only) show analyser console to debug network buffer properties (debugging command)
Note that the debugging commands are not intended for general use.
Jamulus knows four modes of operation:
Client mode and three kinds of Server (Unregistered, Registered, Directory.)
A Unregistered Server is unlisted, Clients can only connect if given the
address (IP address and port). A Registered Server will contact a Directory
(whose address must be given at Server startup) and show up in that Server's
list; Clients can retrieve a list of Registered Servers from the Directory
Server. Several Registered Directories are operated by the Jamulus project;
there is a Directory for each genre, which is how Registered Jamulus Servers
are categorised into genres.
- online handbook
- frequently asked questions
- documentation on Server configuration and types
- current list of Directory Servers operated by the Jamulus project, controlling the “genre”
--ctrlmidichdocumentation and other more or less useful information
- JSON-RPC API Documentation (see
mirabilos ⟨email@example.com⟩ wrote this manual page for the Debian project, but it may be used elsewhere as well.
This manual page was derived from the source code and summarises some of the information from the website, but it could be more helpful.
Some of the networking code assumes Legacy IP (IPv4).
|December 23, 2021||Debian|