~mixxxdevelopers/mixxx/manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
Appendix
********

.. _appendix-keyboard:

Keyboard mapping table
======================

Shortcuts let you work more efficiently. This table lists the default keyboard
shortcuts for accessing Mixxx with an English keyboard layout. Depending on your
language settings the defaults may be different.

.. versionadded:: 1.11
   Auto DJ and Preview Deck shortcuts

+----------------------------------------+---------------------+---------------------+--------------+
| Function                               | Deck 1              | Deck 2              | Master       |
+========================================+=====================+=====================+==============+
| **Mixer**                                                                                         |
+----------------------------------------+---------------------+---------------------+--------------+
| Crossfade Left                         |                     |                     | G            |
+----------------------------------------+---------------------+---------------------+--------------+
| Crossfade Right                        |                     |                     | H            |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Crossfade Left                   |                     |                     | Shift + G    |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Crossfade Right                  |                     |                     | Shift + H    |
+----------------------------------------+---------------------+---------------------+--------------+
| Activate/Disable Effects Unit          | 5                   | 0                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Headphone Cue (Pre-fader listen)       | T                   | Y                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Bass Kill                              | B                   | N                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| **Playback**                                                                                      |
+----------------------------------------+---------------------+---------------------+--------------+
| Load selected track to deck            | Shift + left        | Shift + right       |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Unload track from deck                 | Alt + Shift + left  | Alt + Shift + right |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Playback                               | D                   | L                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Seek Backwards                         | A                   | J                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Reverse Playback                       | Shift + A           | Shift + J           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Seek Forwards                          | S                   | K                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Tempo Adjust Down                      | F1                  | F5                  |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Tempo Adjust Up                        | F2                  | F6                  |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Tempo Adjust Down                | Shift + F1          | Shift + F5          |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Tempo Adjust Up                  | Shift + F2          | Shift + F6          |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Temporary Tempo Adjust Down            | F3                  | F7                  |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Temporary Tempo Adjust Up              | F4                  | F8                  |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Temporary Tempo Adjust Down      | Shift + F3          | Shift + F7          |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Small Temporary Tempo Adjust Up        | Shift + F4          | Shift + F8          |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Tempo (BPM) Sync                       | 1                   | 6                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| BPM Tap Tempo Adjust                   | Shift + !           | Shift + ^           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| **Cue and Loop**                                                                                  |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Cuepoint                           | Shift + D           | Shift + L           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Cue                                    | F                   | ;                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Cue Go-to-and-stop                     | Shift + F           | Shift + :           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Activate 4 Beat Loop                   | Q                   | U                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Halve Beat Loop Size                   | W                   | I                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Double Beat Loop Size                  | E                   | O                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Loop In Point                      | 2                   | 7                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Loop Out Point (Activates Loop)    | 3                   | 8                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Toggle Loop On/Off                     | 4                   | 9                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Hot cue 1                          | Z                   | M                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Hot cue 2                          | X                   | ,                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Hot cue 3                          | C                   | .                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Set Hot cue 4                          | V                   | /                   |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Clear Hot cue 1                        | Shift + Z           | Shift + M           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Clear Hot cue 2                        | Shift + X           | Shift + <           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Clear Hot cue 3                        | Shift + C           | Shift + >           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| Clear Hot cue 4                        | Shift + V           | Shift + ?           |              |
+----------------------------------------+---------------------+---------------------+--------------+
| **Microphone**                                                                                    |
+----------------------------------------+---------------------+---------------------+--------------+
| Microphone Talkover                    |                     |                     | \`           |
+----------------------------------------+---------------------+---------------------+--------------+
| **Auto DJ**                                                                                       |
+----------------------------------------+---------------------+---------------------+--------------+
| Shuffle Auto DJ playlist               |                     |                     | F9           |
+----------------------------------------+---------------------+---------------------+--------------+
| Skip next track in Auto DJ             |                     |                     | F10          |
+----------------------------------------+---------------------+---------------------+--------------+
| Fade to next track in Auto DJ          |                     |                     | F11          |
+----------------------------------------+---------------------+---------------------+--------------+
| Toggle Auto DJ on/Off                  |                     |                     | F12          |
+----------------------------------------+---------------------+---------------------+--------------+
| **Preview Deck**                                                                                  |
+----------------------------------------+---------------------+---------------------+--------------+
| Load Selected Track And Play           |                     |                     | Alt+Return   |
+----------------------------------------+---------------------+---------------------+--------------+
| Start/Stop                             |                     |                     | Return       |
+----------------------------------------+---------------------+---------------------+--------------+
| Seek Backwards                         |                     |                     | Alt + Left   |
+----------------------------------------+---------------------+---------------------+--------------+
| Seek Forwards                          |                     |                     | Alt + Right  |
+----------------------------------------+---------------------+---------------------+--------------+

.. seealso:: Mixxx allows you to customize the keyboard shortcuts. For more
             information, and to download a keyboard mapping image, go to
             :ref:`control-keyboard`.

.. _appendix-shortcuts:

Application shortcuts
=====================

Use these shortcuts to access features available in the menu on top of the
application window.

================================  ================================
Function                          Key
================================  ================================
**File menu**
------------------------------------------------------------------
Load Track to Deck 1              Ctrl + O
--------------------------------  --------------------------------
Load Track to Deck 2              Ctrl + Shift + O
--------------------------------  --------------------------------
**Library menu**
------------------------------------------------------------------
Add new Playlist                  Ctrl + N
--------------------------------  --------------------------------
Add new Crate                     Ctrl + Shift + N
--------------------------------  --------------------------------
**View menu**
------------------------------------------------------------------
Show Samplers                     Ctrl + 1
--------------------------------  --------------------------------
Show Microphone Section           Ctrl + 2
--------------------------------  --------------------------------
Show Vinyl Control Section        Ctrl + 3
--------------------------------  --------------------------------
Show Preview Deck                 Ctrl + 4
--------------------------------  --------------------------------
Full Screen (Windows & Linux)     F11
--------------------------------  --------------------------------
Full Screen (Mac OS X)            Ctrl + Shift + F
--------------------------------  --------------------------------
**Options menu**
------------------------------------------------------------------
Enable Vinyl Control 1            Ctrl + Y
--------------------------------  --------------------------------
Enable Vinyl Control 2            Ctrl + Z
--------------------------------  --------------------------------
Enable Live Broadcasting          Ctrl + L
--------------------------------  --------------------------------
Record Mix                        Ctrl + R
--------------------------------  --------------------------------
Enable Keyboard Shortcuts         Ctrl + \`
--------------------------------  --------------------------------
Exit Mixxx                        Ctrl + Q
--------------------------------  --------------------------------
**Developer menu**
------------------------------------------------------------------
Reload skin                       Ctrl + Shift + R
================================  ================================

.. hint:: The :kbd:`Ctrl` key on Windows & Linux is equivalent to the
          :kbd:`Command` key on Mac OS X. The :kbd:`Alt` key on Windows & Linux
          is equivalent to the :kbd:`Option` key on Mac OS X. Application
          shortcuts are not customizable.

.. note:: The Developer menu is available if Mixxx is started using the
          :ref:`appendix-command-line-options`.

.. _appendix-command-line-options:

Command line options
====================

Mixxx is designed to be as user-friendly as possible. As such, its command line
options are only useful for development or debugging, as they make these tasks
easier. Comment line options are case-sensitive.

======================  =================================================
Option                  Description
======================  =================================================
[FILE]                  Load the specified music file(s) at start-up.
                        Each file you specify will be loaded into the
                        next virtual deck. Supported file types: mp3, ogg,
                        aiff, aif, wav, flac, and optional unprotected
                        aac (m4a)
----------------------  -------------------------------------------------
--resourcePath PATH     Top-level directory where Mixxx should look
                        for its resource files such as MIDI mappings,
                        overriding the default installation location.
----------------------  -------------------------------------------------
--pluginPath PATH       Top-level directory where Mixxx should look
                        for sound source plugins in addition to default
                        locations.
----------------------  -------------------------------------------------
--settingsPath PATH     Top-level directory where Mixxx should look
                        for user settings files such as the library
                        database and preferences config file.
----------------------  -------------------------------------------------
--controllerDebug       Causes Mixxx to display/log all of the controller
                        data it receives and script functions it loads
----------------------  -------------------------------------------------
--developer             Enables developer-mode. Includes extra log info,
                        stats on performance, and a Developer tools menu.
----------------------  -------------------------------------------------
--locale LOCALE         Use a custom locale for loading translations
                        (e.g 'fr')
----------------------  -------------------------------------------------
-f, --fullScreen        Starts Mixxx in full-screen mode
----------------------  -------------------------------------------------
-h, --help              Display this help message and exit
======================  =================================================

**Example:**
To start Mixxx in Developer mode from a custom resource directory with
:term:`MIDI` and :term:`HID` logging enabled, type the following line into the
terminal and hit return: ::

  ./mixxx --controllerDebug --developer --resourcePath res