Skip to content

Commit ad0a2ce

Browse files
committed
chore: migrate hardware manual to Markdown (part 2)
1 parent ac7a954 commit ad0a2ce

56 files changed

Lines changed: 5994 additions & 4910 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,4 +480,5 @@
480480
myst_enable_extensions = [
481481
"attrs_block",
482482
"colon_fence",
483+
"deflist",
483484
]

source/hardware/controllers/american_audio_radius_2000.md

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 128 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
American Audio VMS2
2-
===================
1+
# American Audio VMS2
32

43
The American Audio VMS2 is a 2-deck all-in-one controller. It is a USB
54
class compliant MIDI and audio device that works with GNU/Linux, Mac OS
@@ -10,18 +9,17 @@ can also be used as a stand-alone mixer with analog sources without a
109
computer by setting the USB/Analog switches on the front of the device
1110
to “Analog”.
1211

13-
- `Manufacturer’s product page <http://www.americandj.eu/en/vms2.html>`__, provides manual and drivers for download.
14-
- `Forum thread <https://mixxx.discourse.group/t/american-audio-vms2/12000>`__, for discussion of mapping options.
15-
- `Pull Request <https://github.com/mixxxdj/mixxx/pull/876>`__, which this wiki page describes.
12+
- [Manufacturer’s product page](http://www.americandj.eu/en/vms2.html), provides manual and drivers for download.
13+
- [Forum thread](https://mixxx.discourse.group/t/american-audio-vms2/12000), for discussion of mapping options.
14+
- [Pull Request](https://github.com/mixxxdj/mixxx/pull/876), which this wiki page describes.
1615

17-
.. versionadded:: 1.11
18-
19-
Audio Setup
20-
-----------
16+
:::{versionadded} 1.11
17+
:::
18+
## Audio Setup
2119

2220
No driver needs to be installed on GNU/Linux or Mac OS X. However, on
2321
Windows, it is recommended to install the driver from the manufacturer
24-
to be able to use the :ref:`ASIO sound API <preferences-sound-api>`.
22+
to be able to use the {ref}`ASIO sound API <preferences-sound-api>`.
2523

2624
Unlike most controllers with built in sound cards, which rely on Mixxx
2725
to do all mixing in software, the VMS2 mixes signals from the sound card
@@ -30,7 +28,7 @@ in hardware. To use it with Mixxx:
3028
- Bypass the built-in hardware equalizer of the VMS2 (i.e. use Post-EQ
3129
Mode). Hold the forward search button on the right deck as you turn
3230
the VMS2 on to switch between Post-EQ and Pre-EQ modes. See section
33-
15 of the `manufacturer’s manual <http://adjmedia.s3-website-eu-west-1.amazonaws.com/manuals/vms2_print_EN.pdf>`__
31+
15 of the [manufacturer’s manual](http://adjmedia.s3-website-eu-west-1.amazonaws.com/manuals/vms2_print_EN.pdf)
3432
for details.
3533
- Set the USB/Analog switches on the front side of the VMS2 to “USB”
3634
- In Mixxx’s Sound Hardware Preferences:
@@ -45,8 +43,7 @@ route the headphone output there to also pre-listen using the preview
4543
deck. Of course, if you do so, attach the headphones to that other
4644
soundcard instead of the VMS2.
4745

48-
Input and Recording
49-
~~~~~~~~~~~~~~~~~~~
46+
### Input and Recording
5047

5148
The analog inputs are captured by the built-in soundcard as input
5249
signals. They can be used for timecode signals (e.g. timecode vinyl), as
@@ -71,61 +68,80 @@ the same in hardware and software. If you require a recording that
7168
captures exactly what the audience will hear, use a separate soundcard
7269
and recording software to record from the VMS2 booth output.
7370

74-
Mapping description
75-
-------------------
71+
## Mapping description
7672

77-
Mixer section
78-
~~~~~~~~~~~~~
73+
### Mixer section
7974

8075
All main functions are mapped straightforwardly:
8176

82-
============== ======================
83-
VMS2 Control Mixxx Control
84-
============== ======================
85-
Crossfader Crossfader
86-
Volume Fader Volume Fader
87-
Cue (PFL) PFL
88-
Cue Mix Cue Mix (PFL / Main)
89-
Headphone Gain Headphone Gain
90-
Channel Gain Channel Gain
91-
Master Gain Main Gain
92-
============== ======================
93-
94-
As noted in the `#Audio Setup <#Audio%20Setup>`__ section, these control
77+
```{list-table}
78+
:header-rows: 1
79+
80+
* - VMS2 Control
81+
- Mixxx Control
82+
* - Crossfader
83+
- Crossfader
84+
* - Volume Fader
85+
- Volume Fader
86+
* - Cue (PFL)
87+
- PFL
88+
* - Cue Mix
89+
- Cue Mix (PFL / Main)
90+
* - Headphone Gain
91+
- Headphone Gain
92+
* - Channel Gain
93+
- Channel Gain
94+
* - Master Gain
95+
- Main Gain
96+
```
97+
98+
As noted in the [#Audio Setup](#Audio%20Setup) section, these control
9599
the VMS2’s hardware mixer. Although the state of the controls is
96100
reflected on screen in Mixxx, the actual mixing is done by the VMS2’s
97101
hardware mixer.
98102

99-
Deck Control
100-
~~~~~~~~~~~~
103+
### Deck Control
101104

102105
Deck control is straightforward, too:
103106

104-
===================== ===============================================
105-
VMS2 Control Mixxx Control
106-
===================== ===============================================
107-
Play Toggle deck play/pause
108-
Pause Pause the deck
109-
Cue Cue Point (configure behavior in software)
110-
Pitch +/- Temporary pitch bend +/-
111-
Pitch Fader Pitch Fader
112-
Range (Shift+Sync) Cycle pitch fader range (+-8/10/30/100%)
113-
Sync Sync to other deck
114-
Search <</>> Search through currently loaded track
115-
Keylock (Shift+Vinyl) Toggle pitch independent time stretch (KeyLock)
116-
Vinyl Toggle between Scratch mode and Pitch mode
117-
Platter Touch sensitive platters! Scratch or Pitchbend
118-
Shift + Platter Scroll through library quickly
119-
===================== ===============================================
107+
```{list-table}
108+
:header-rows: 1
109+
110+
* - VMS2 Control
111+
- Mixxx Control
112+
* - Play
113+
- Toggle deck play/pause
114+
* - Pause
115+
- Pause the deck
116+
* - Cue
117+
- Cue Point (configure behavior in software)
118+
* - Pitch +/-
119+
- Temporary pitch bend +/-
120+
* - Pitch Fader
121+
- Pitch Fader
122+
* - Range (Shift+Sync)
123+
- Cycle pitch fader range (+-8/10/30/100%)
124+
* - Sync
125+
- Sync to other deck
126+
* - Search <</>>
127+
- Search through currently loaded track
128+
* - Keylock (Shift+Vinyl)
129+
- Toggle pitch independent time stretch (KeyLock)
130+
* - Vinyl
131+
- Toggle between Scratch mode and Pitch mode
132+
* - Platter
133+
- Touch sensitive platters! Scratch or Pitchbend
134+
* - Shift + Platter
135+
- Scroll through library quickly
136+
```
120137

121138
In Pitch mode, moving the platters from either the top or side will only
122139
bend the pitch of the deck. In Scratch mode, the platters act like vinyl
123140
turntables and can be used for scratching. Touching and holding them
124141
from the top stops the deck. Moving them from the edge does not stop the
125142
deck.
126143

127-
Library and Track loading
128-
~~~~~~~~~~~~~~~~~~~~~~~~~
144+
### Library and Track loading
129145

130146
Use the encoder in the center of the controller to browse through the
131147
library. Press the encoder to switch between library main window and
@@ -137,67 +153,86 @@ the left or right deck.
137153

138154
The four directional buttons around the knob also control the library:
139155

140-
====== ======================
141-
Button Library function
142-
====== ======================
143-
Up Previous library entry
144-
Down Next library entry
145-
Left Previous sidebar entry
146-
Right Next sidebar entry
147-
====== ======================
156+
```{list-table}
157+
:header-rows: 1
158+
159+
* - Button
160+
- Library function
161+
* - Up
162+
- Previous library entry
163+
* - Down
164+
- Next library entry
165+
* - Left
166+
- Previous sidebar entry
167+
* - Right
168+
- Next sidebar entry
169+
```
148170

149171
If you hold Shift and then rotate a platter, you can scroll through the
150172
library much faster.
151173

152-
Equalizer
153-
~~~~~~~~~
174+
### Equalizer
154175

155176
The per deck EQ rotaries are mapped to their software counterparts. The
156177
VMS2 has no dedicated kill switches for the EQ. However, in Mixxx,
157178
pressing the following buttons with Shift acts as EQ kill switches.
158179

159-
============ ================
160-
VMS2 Control Mixxx Control
161-
============ ================
162-
Shift+IN Kill Switch Low
163-
Shift+OUT Kill Switch Mid
164-
Shift+RELOOP Kill Switch High
165-
============ ================
180+
```{list-table}
181+
:header-rows: 1
182+
183+
* - VMS2 Control
184+
- Mixxx Control
185+
* - Shift+IN
186+
- Kill Switch Low
187+
* - Shift+OUT
188+
- Kill Switch Mid
189+
* - Shift+RELOOP
190+
- Kill Switch High
191+
```
166192

167-
Hotcues
168-
~~~~~~~
193+
### Hotcues
169194

170195
The VMS2 can control 6 hotcues per deck.
171196

172-
+-------------------------------------------------+---------------------------+
173-
| VMS2 Control | Mixxx Control |
174-
+=================================================+===========================+
175-
| 1 / 2 / 3 | Set/Jump HotCue 1 / 2 / 3 |
176-
+-------------------------------------------------+---------------------------+
177-
| Vinyl + 1 / 2 / 3 | Delete HotCue 1 / 2 / 3 |
178-
+-------------------------------------------------+---------------------------+
179-
| 4 / 5 / 6 = (Shift + 1 / 2 / 3) | Set/Jump HotCue 4 / 5 / 6 |
180-
+-------------------------------------------------+---------------------------+
181-
| Vinyl + 4 / 5 / 6 = (Vinyl + Shift + 1 / 2 / 3) | Delete HotCue 4 / 5 / 6 |
182-
+-------------------------------------------------+---------------------------+
197+
```{list-table}
198+
:header-rows: 1
199+
200+
* - VMS2 Control
201+
- Mixxx Control
202+
* - 1 / 2 / 3
203+
- Set/Jump HotCue 1 / 2 / 3
204+
* - Vinyl + 1 / 2 / 3
205+
- Delete HotCue 1 / 2 / 3
206+
* - 4 / 5 / 6 = (Shift + 1 / 2 / 3)
207+
- Set/Jump HotCue 4 / 5 / 6
208+
* - Vinyl + 4 / 5 / 6 = (Vinyl + Shift + 1 / 2 / 3)
209+
- Delete HotCue 4 / 5 / 6
210+
```
183211

184212
Pressing the vinyl/keylock button will not toggle scratch mode or
185213
keylock as long as a hotcue is deleted before releasing the
186214
vinyl/keylock button.
187215

188-
Loops
189-
~~~~~
190-
191-
==================== =========================================
192-
VMS2 Control Mixxx Control
193-
==================== =========================================
194-
IN Mark beginning of loop
195-
OUT Mark end of loop
196-
RELOOP Leave / Reenter current loop
197-
LOOP Start a 4 Beat loop from current position
198-
Smart (Shift + Loop) Toggle quantize
199-
(\:2) / (\*2) Halve or double the current loop length
200-
==================== =========================================
216+
### Loops
217+
218+
```{list-table}
219+
:header-rows: 1
220+
221+
* - VMS2 Control
222+
- Mixxx Control
223+
* - IN
224+
- Mark beginning of loop
225+
* - OUT
226+
- Mark end of loop
227+
* - RELOOP
228+
- Leave / Reenter current loop
229+
* - LOOP
230+
- Start a 4 Beat loop from current position
231+
* - Smart (Shift + Loop)
232+
- Toggle quantize
233+
* - (\:2) / (\*2)
234+
- Halve or double the current loop length
235+
```
201236

202237
As Mixxx currently only supports one active loop per deck, the secondary
203238
loop controls have been remapped to EQ kill switches.

0 commit comments

Comments
 (0)