Skip to content

Commit 57bf5dd

Browse files
committed
Update main window Menu section
1 parent 9fe7f2b commit 57bf5dd

File tree

1 file changed

+64
-20
lines changed

1 file changed

+64
-20
lines changed

wiki/en/Software-Manual.md

Lines changed: 64 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This manual documents the Jamulus Client application for use by musicians and si
1616
* TOC
1717
{:toc}
1818

19-
</details>
19+
</details>
2020

2121
# Main Window
2222

@@ -28,7 +28,7 @@ This manual documents the Jamulus Client application for use by musicians and si
2828

2929
## Ping, Delay and Jitter
3030

31-
**Ping** shows your network latency in milliseconds, the lower the better. Ping time contributes to overall delay (see below). The most probable cause of a high ping is that your distance to the server is too large.
31+
**Ping** shows your network latency in milliseconds, the lower the better. Ping time contributes to overall delay (see below). The most probable cause of a high ping is that your distance to the server is too large.
3232

3333
**Delay** shows overall latency calculated from the current ping time and the delay introduced by the current audio buffer settings. The LEDs show the status of this as:
3434

@@ -71,7 +71,7 @@ to the right and move the fader upwards until the desired reverb level is reache
7171

7272
Opens the chat window. Text entered is sent to
7373
all connected Clients. If a new chat message arrives and the Chat dialogue is not already open, it will
74-
open automatically for all Clients. See Settings to optionally turn on a sound alert when a new chat message is received.
74+
open automatically for all Clients. See Settings to optionally turn on a sound alert when a new chat message is received.
7575

7676
## Connect/disconnect button
7777

@@ -109,8 +109,6 @@ If you have set your Audio Channel to Stereo or Stereo Out in your Settings, you
109109

110110
If you see a "mute" icon above a user, it means that person cannot hear you. Either they have muted you, soloed one or more users not including you, or have set your fader in their mix to zero.
111111

112-
Users usually appear left-to-right in the order that they connect. You can sort instead by name, instrument, group, or city using the View menu.
113-
114112
If the server operator has enabled recording, you will see a message above the mixer showing that you are being recorded.
115113

116114
### Grp button
@@ -119,14 +117,70 @@ You can group users together using the "group" toggle. Moving the fader of any m
119117

120118
### Mute button
121119

122-
Prevents users being heard in your local mix. Be aware that when you mute someone, they will see a "muted" icon above your fader to indicate that you cannot hear them. Note also that you will continue to see their VU meters moving if sound from the muted user is reaching the server. Your fader position for them is also unaffected.
120+
Prevents users being heard in your local mix. Be aware that when you mute someone, they will see a "muted" icon above your fader to indicate that you cannot hear them. Note also that you will continue to see their VU meters moving if sound from the muted user is reaching the server. Your fader position for them is also unaffected.
123121

124122
Note that muting your **own** channel only means you will not hear your signal from the server (and is not advised as it can lead to you becoming out of time with other players). This is therefore not the same as using "[Mute Myself](#mute-myself-button)".
125123

126124
### Solo button
127125

128126
Allows you to hear one or more users on their own. Those not soloed will be muted. Note also that those people who are not soloed will see a "muted" icon above your fader.
129127

128+
## Menu commands
129+
130+
### File > Connection Setup...
131+
132+
Opens the [connection dialogue (see above)](#connectdisconnect-button).
133+
134+
### File > Load/Save Mixer Channels Setup
135+
136+
You can save and restore the mix you have for your band rehearsals (fader, mute, pan, solo etc.) and load these any time (even while you are playing). Loading can also be done by drag/drop to the mixer window.
137+
138+
### File > Exit
139+
140+
Closes all the windows and exits the application.
141+
142+
### Edit > Clear All Stored Solo/Mute Settings
143+
144+
Whenever you Solo or Mute a channel, Jamulus stores the settings against them, so that if they leave and rejoin - or you join a server where they are playing - the settings will automatically be applied. If you want clear _all_ stored settings, you can do it here.
145+
146+
### Edit > Set All Faders to New Client Level
147+
148+
Applies the [configured "New Client Level"](#new-client-level) to all currently connected channels.
149+
150+
### Edit > Auto-Adjust All Faders
151+
152+
Applies a one-off fader setting to each channel depending on its volume. Useful for large ensembles to get a reasonable overall mix, although individual adjustments might still be necessary. Best applied during a warm-up or a uniform part of the music piece.
153+
154+
### View > (sort options)
155+
156+
Most items under the "View" menu allow you to adjust the order Jamulus chooses to display channels on the server:
157+
* Own Fader First<br/>
158+
This option can be used in addition to the others to move your own channel to always be the leftmost.
159+
160+
* No user sorting<br/>
161+
This does not take any user details into account when sorting. It sorts by the order channels join the current server, with new channels being added to the right-hand end.
162+
* Sort by Name<br/>
163+
Sorts by the name someone has chosen in their profile.
164+
* Sort by Instrument / City
165+
Sorts by the instrument or city someone has in their profile, along with their name.
166+
* Sort by Group<br/>
167+
Where the fader group feature is in use, this sorts in ascending group number from left to right (and within that, by name), with all ungrouped channel off to the right.
168+
* Sort by Server Channel<br/>
169+
Where Jamulus channel controls (fader, mute, solo, etc) are being controlled by MIDI (see [Using --ctrlmidich for MIDI controllers](Tips-Tricks-More#using-ctrlmidich-for-midi-controllers)), this sorts by the server-assigned channel number to help ensure a stable sort order that aligns with MIDI hardware controls.
170+
171+
### View > Chat
172+
173+
Opens the [Chat](#chat) window.
174+
175+
### Settings Menu
176+
177+
Allows direct access to each of the [Settings](#settings) tabs.
178+
179+
### Help
180+
181+
Provides access to the [Getting Started](Getting-Started) and [User Manual](Software-Manual) (this page) on the website, along with copyright, licence and acknowledgement details. There is also a "What's This?" option for getting more details on parts of the client display.
182+
183+
130184
# Settings
131185

132186
## My Profile
@@ -146,7 +200,7 @@ This applies a skin to the main window, some of which are designed to accommodat
146200

147201
### Meter style
148202

149-
This changes the visual style of the audio meters, independently of the chosen skin.
203+
This changes the visual style of the audio meters, independently of the chosen skin.
150204

151205
### Mixer rows
152206

@@ -175,7 +229,7 @@ a different actual sound card channel can be selected.
175229

176230
### Audio channels
177231

178-
Selects the number of audio channels to be used for communication between Client and server.
232+
Selects the number of audio channels to be used for communication between Client and server.
179233

180234
**Note**: It is better to run separate Client instances per voice/instrument, where each Client has its own ini file, rather than using this built-in mono pair to stereo mixer.
181235

@@ -268,30 +322,20 @@ Increases the gain from your device. Use this if your device delivers a gain tha
268322

269323
### Feedback Protection
270324

271-
Attempts to detect audio feedback loops or loud noise in the first three seconds after you connected to a server. Once detected, this feature will show a message and activate the "Mute Myself" button to mute you in your own mix.
325+
Attempts to detect audio feedback loops or loud noise in the first three seconds after you connected to a server. Once detected, this feature will show a message and activate the "Mute Myself" button to mute you in your own mix.
272326

273327
### Input Balance
274328

275329
Controls the relative levels of the left and right local audio channels. For a mono signal
276330
it acts as a pan between the two channels. For example, if a microphone is connected to the right input channel and
277331
an instrument is connected to the left input channel which is much louder than the microphone, move the audio fader to increase the relative volume of the mic.
278332

279-
# Menu commands
280-
281-
### File > Load/Save Mixer Channels Setup
282-
283-
You can save and restore the mix you have for your band rehearsals (fader, mute, pan, solo etc.) and load these any time (even while you are playing). Loading can also be done by drag/drop to the mixer window.
284-
285-
### Edit > Auto-Adjust All Faders
286-
287-
Applies a one-off fader setting to each channel depending on its volume. Useful for large ensembles to get a reasonable overall mix, although individual adjustments might still be necessary. Best applied during a warm-up or a uniform part of the music piece.
288-
289333
# Backing up Jamulus
290334

291335
{% include_relative Include-Backing-Up.md %}
292336
* You can save and load different mixer settings using [Load/Save Mixer Channels Setup](Software-Manual#file--loadsave-mixer-channels-setup) and store those files wherever you want.
293337

294-
**Note for macOS users:** As of Jamulus 3.8.1, we have a signed installer. This will store the settings in
338+
**Note for macOS users:** As of Jamulus 3.8.1, we have a signed installer. This will store the settings in
295339
```shell
296340
$HOME/Library/Containers/app.jamulussoftware.Jamulus/Data/.config/Jamulus/
297341
```

0 commit comments

Comments
 (0)