User Tools

Site Tools


mixxxcontrols

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
mixxxcontrols [2018/12/16 17:55]
daschuer [EQs and filters]
mixxxcontrols [2019/08/11 13:09]
be.ing document intro & outro cues
Line 23: Line 23:
  
 When running Mixxx in Developer Mode (with the ''​%%--%%developer''​ command line option), you can view and manually set the state of any control in Mixxx by going to Developer > Developer Tools. When running Mixxx in Developer Mode (with the ''​%%--%%developer''​ command line option), you can view and manually set the state of any control in Mixxx by going to Developer > Developer Tools.
 +
 +=====  Naming Conventions ​ =====
 +
 +The keys of existing controls use different naming conventions,​ namely
 +
 +  * **//​PascalCase//​**:​ ''​VuMeter'',​ ''​MoveUp'',​ ...
 +  * **//​camelCase//​**:​ ''​headSplit'',​ ''​duckStrength'',​ ...
 +  * **//​snake_case//​**:​ ''​beatjump_forward'',​ ''​cue_indicator''​
 +
 +Newly added controls should use the **//​snake_case//​** naming convention(([[https://​github.com/​mixxxdj/​mixxx/​pull/​2118#​issuecomment-498126595|GitHub PR #2118 - Naming conventions for new controls]])).
  
 =====  List of Controls ​ ===== =====  List of Controls ​ =====
Line 116: Line 126:
 | <​del>​bpm_tap((introduced in Mixxx v1.9.0))</​del> ​                 || <​del>​binary</​del> ​            || <​del>​When tapped repeatedly, adjusts the playback rate of ChannelN to match the tapped BPM</​del> ​                                                                                                                                                                                                     || <​del>​track playback rate shifts after 4 or more taps</​del> ​                                                                                                                      || | <​del>​bpm_tap((introduced in Mixxx v1.9.0))</​del> ​                 || <​del>​binary</​del> ​            || <​del>​When tapped repeatedly, adjusts the playback rate of ChannelN to match the tapped BPM</​del> ​                                                                                                                                                                                                     || <​del>​track playback rate shifts after 4 or more taps</​del> ​                                                                                                                      ||
 | bpm_tap((introduced in Mixxx v1.9.2)) ​                            || binary ​                       || When tapped repeatedly, adjusts the BPM of ChannelN to match the tapped BPM                                                                                                                                                                                                                           || BPM value display (play speed doesn'​t change) ​                                                                                                                                   || | bpm_tap((introduced in Mixxx v1.9.2)) ​                            || binary ​                       || When tapped repeatedly, adjusts the BPM of ChannelN to match the tapped BPM                                                                                                                                                                                                                           || BPM value display (play speed doesn'​t change) ​                                                                                                                                   ||
 +| CloneFromDeck((introduced in Mixxx v2.3.0)) ​                      || integer ​                      || Clone the given deck number, copying the play state, position, rate, and key. If 0 or a negative number is given, Mixxx will attempt to select the first playing deck as the source for the clone. ​                                                                                                   || The channel will start playing at the rate and position of the source deck.                                                                                                      ||
 | cue_default ​                                                      || binary ​                       || In CDJ mode, when playing, returns to the cue point & pauses. If stopped, sets a cue point at the current location. If stopped and at a cue point, plays from that point until released (set to 0.)                                                                                                   || CUE button ​                                                                                                                                                                      || | cue_default ​                                                      || binary ​                       || In CDJ mode, when playing, returns to the cue point & pauses. If stopped, sets a cue point at the current location. If stopped and at a cue point, plays from that point until released (set to 0.)                                                                                                   || CUE button ​                                                                                                                                                                      ||
 | cue_gotoandplay((introduced in Mixxx v1.11.0)) ​                   || binary ​                       || If the Cue point is set, seeks the player to it and starts playback. ​                                                                                                                                                                                                                                 || Player may change position and start playing. ​                                                                                                                                   || | cue_gotoandplay((introduced in Mixxx v1.11.0)) ​                   || binary ​                       || If the Cue point is set, seeks the player to it and starts playback. ​                                                                                                                                                                                                                                 || Player may change position and start playing. ​                                                                                                                                   ||
Line 129: Line 140:
 | eject((introduced in Mixxx v1.9.0)) ​                              || binary ​                       || Eject currently loaded track                                                                                                                                                                                                                                                                          || Eject button is lit. Be sure to set back to 0 with scripts so the button does not stay lit.                                                                                      || | eject((introduced in Mixxx v1.9.0)) ​                              || binary ​                       || Eject currently loaded track                                                                                                                                                                                                                                                                          || Eject button is lit. Be sure to set back to 0 with scripts so the button does not stay lit.                                                                                      ||
 | end                                                               || binary ​                       || Jump to end of track                                                                                                                                                                                                                                                                                  || Track jumps to end                                                                                                                                                               || | end                                                               || binary ​                       || Jump to end of track                                                                                                                                                                                                                                                                                  || Track jumps to end                                                                                                                                                               ||
 +| end_of_track ​                                                     || read-only, binary ​            || Switches to "​1"​ if the play osition is within the '​end'​ range defined in Preferences > Waveforms > "End of track warning" ​                                                                                                                                                                            || Waveform and Overview widgets show a flashing border ​                                                                                                                            ||
 | file_bpm ​                                                         || positive value                || (Read-only) the detected BPM of the loaded track                                                                                                                                                                                                                                                      || N/A                                                                                                                                                                              || | file_bpm ​                                                         || positive value                || (Read-only) the detected BPM of the loaded track                                                                                                                                                                                                                                                      || N/A                                                                                                                                                                              ||
 | file_key((introduced in Mixxx v2.0.0)) ​                           || ?                             || (Read-only) the detected key of the loaded track                                                                                                                                                                                                                                                      || N/A                                                                                                                                                                              || | file_key((introduced in Mixxx v2.0.0)) ​                           || ?                             || (Read-only) the detected key of the loaded track                                                                                                                                                                                                                                                      || N/A                                                                                                                                                                              ||
Line 140: Line 152:
 | hotcue_X_position((introduced in Mixxx v1.8.0)) ​                  || positive integer ​             || The position of hotcue X in samples, -1 if not set.                                                                                                                                                                                                                                                   || Hotcue X marker changes on waveform. ​                                                                                                                                            || | hotcue_X_position((introduced in Mixxx v1.8.0)) ​                  || positive integer ​             || The position of hotcue X in samples, -1 if not set.                                                                                                                                                                                                                                                   || Hotcue X marker changes on waveform. ​                                                                                                                                            ||
 | hotcue_X_set((introduced in Mixxx v1.8.0)) ​                       || binary ​                       || Set hotcue X to the current play position. If hotcue X was previously set, clears its hotcue status. ​                                                                                                                                                                                                 || Hotcue X marker changes on waveform. ​                                                                                                                                            || | hotcue_X_set((introduced in Mixxx v1.8.0)) ​                       || binary ​                       || Set hotcue X to the current play position. If hotcue X was previously set, clears its hotcue status. ​                                                                                                                                                                                                 || Hotcue X marker changes on waveform. ​                                                                                                                                            ||
 +| intro_end_activate((introduced in Mixxx v2.3.0)) ​                  || binary ​                       || If the intro end cue is set, seeks the player to the intro end position. If the intro end is not set, sets the intro end to the current play position. ​                                                                                  || Player may change position. Intro end marker may change on waveform. ​                                                                                                             ||
 +| intro_end_clear((introduced in Mixxx v2.3.0)) ​                     || binary ​                       || If the intro end cue is set, clears its status. ​                                                                                                                                                                                                                                                        || Intro end marker changes on waveform. ​                                                                                                                                            ||
 +| intro_end_enabled((introduced in Mixxx v2.3.0)) ​                   || read-only, binary ​            || 1 if intro end cue is set, (position is not -1), 0 otherwise. ​                                                                                                                                                                                                                                          || Intro end button lights up. ||                                                                                                                                                                                  ​
 +| intro_end_position((introduced in Mixxx v2.3.0)) ​                  || positive integer ​             || The position of the intro end in samples, -1 if not set.                                                                                                                                                                                                                                                   || Intro end marker changes on waveform. ​                                                                                                                                            ||
 +| intro_end_set((introduced in Mixxx v2.3.0)) ​                       || binary ​                       || Set intro end to the current play position. If intro end was previously set, it is moved to the new position. ​                                                                                                                                                                                                 || Intro end marker changes on waveform. ||
 +| intro_start_activate((introduced in Mixxx v2.3.0)) ​                  || binary ​                       || If the intro start cue is set, seeks the player to the intro start position. If the intro start is not set, sets the intro start to the current play position. ​                                                                                  || Player may change position. Intro start marker may change on waveform. ​                                                                                                             ||
 +| intro_start_clear((introduced in Mixxx v2.3.0)) ​                     || binary ​                       || If the intro start cue is set, clears its status. ​                                                                                                                                                                                                                                                        || Intro start marker changes on waveform. ​                                                                                                                                            ||
 +| intro_start_enabled((introduced in Mixxx v2.3.0)) ​                   || read-only, binary ​            || 1 if intro start cue is set, (position is not -1), 0 otherwise. ​                                                                                                                                                                                                                                          || Intro start button lights up. ||
 +| intro_start_position((introduced in Mixxx v2.3.0)) ​                  || positive integer ​             || The position of the intro start in samples, -1 if not set.                                                                                                                                                                                                                                                   || Intro start marker changes on waveform. ​                                                                                                                                            ||
 +| intro_start_set((introduced in Mixxx v2.3.0)) ​                       || binary ​                       || Set intro start to the current play position. If intro start was previously set, it is moved to the new position. ​                                                                                                                                                                                                 || Intro start marker changes on waveform. ​                                                                                                                                            ||
 | key((introduced in Mixxx v2.0.0)) ​                                || real-valued ​                  || Current key of the track                                                                                                                                                                                                                                                                              ||                                                                                                                                                                                  || | key((introduced in Mixxx v2.0.0)) ​                                || real-valued ​                  || Current key of the track                                                                                                                                                                                                                                                                              ||                                                                                                                                                                                  ||
 | keylock((introduced in Mixxx v1.9.0)) ​                            || binary ​                       || Enable key-lock for the specified deck (rate changes only affect tempo, not key)                                                                                                                                                                                                                      || key-lock button activates ​                                                                                                                                                       || | keylock((introduced in Mixxx v1.9.0)) ​                            || binary ​                       || Enable key-lock for the specified deck (rate changes only affect tempo, not key)                                                                                                                                                                                                                      || key-lock button activates ​                                                                                                                                                       ||
Line 158: Line 180:
 | loop_start_position((introduced in Mixxx v1.8.0)) ​                || positive integer ​             || The player loop-in position in samples, -1 if not set.                                                                                                                                                                                                                                                || Loop-in marker changes on waveform. ​                                                                                                                                             || | loop_start_position((introduced in Mixxx v1.8.0)) ​                || positive integer ​             || The player loop-in position in samples, -1 if not set.                                                                                                                                                                                                                                                || Loop-in marker changes on waveform. ​                                                                                                                                             ||
 | orientation((introduced in Mixxx v1.9.0)) ​                        || 0-2                           || Crossfader assignment. 0 = left side of crossfader, 1 = center (not affected by crossfader),​ 2 = right side of crossfader ​                                                                                                                                                                            || N/A                                                                                                                                                                              || | orientation((introduced in Mixxx v1.9.0)) ​                        || 0-2                           || Crossfader assignment. 0 = left side of crossfader, 1 = center (not affected by crossfader),​ 2 = right side of crossfader ​                                                                                                                                                                            || N/A                                                                                                                                                                              ||
 +| outro_end_activate((outroduced in Mixxx v2.3.0)) ​                  || binary ​                       || If the outro end cue is set, seeks the player to the outro end position. If the outro end is not set, sets the outro end to the current play position. ​                                                                                  || Player may change position. Outro end marker may change on waveform. ​                                                                                                             ||
 +| outro_end_clear((outroduced in Mixxx v2.3.0)) ​                     || binary ​                       || If the outro end cue is set, clears its status. ​                                                                                                                                                                                                                                                        || Outro end marker changes on waveform. ​                                                                                                                                            ||
 +| outro_end_enabled((outroduced in Mixxx v2.3.0)) ​                   || read-only, binary ​            || 1 if outro end cue is set, (position is not -1), 0 otherwise. ​                                                                                                                                                                                                                                          || Outro end button lights up. ||                                                                                                                                                                                  ​
 +| outro_end_position((outroduced in Mixxx v2.3.0)) ​                  || positive integer ​             || The position of the outro end in samples, -1 if not set.                                                                                                                                                                                                                                                   || Outro end marker changes on waveform. ​                                                                                                                                            ||
 +| outro_end_set((outroduced in Mixxx v2.3.0)) ​                       || binary ​                       || Set outro end to the current play position. If outro end was previously set, it is moved to the new position. ​                                                                                                                                                                                                 || Outro end marker changes on waveform. ||
 +| outro_start_activate((outroduced in Mixxx v2.3.0)) ​                  || binary ​                       || If the outro start cue is set, seeks the player to the outro start position. If the outro start is not set, sets the outro start to the current play position. ​                                                                                  || Player may change position. Outro start marker may change on waveform. ​                                                                                                             ||
 +| outro_start_clear((outroduced in Mixxx v2.3.0)) ​                     || binary ​                       || If the outro start cue is set, clears its status. ​                                                                                                                                                                                                                                                        || Outro start marker changes on waveform. ​                                                                                                                                            ||
 +| outro_start_enabled((outroduced in Mixxx v2.3.0)) ​                   || read-only, binary ​            || 1 if outro start cue is set, (position is not -1), 0 otherwise. ​                                                                                                                                                                                                                                          || Outro start button lights up. ||
 +| outro_start_position((outroduced in Mixxx v2.3.0)) ​                  || positive integer ​             || The position of the outro start in samples, -1 if not set.                                                                                                                                                                                                                                                   || Outro start marker changes on waveform. ​                                                                                                                                            ||
 +| outro_start_set((outroduced in Mixxx v2.3.0)) ​                       || binary ​                       || Set outro start to the current play position. If outro start was previously set, it is moved to the new position. ​                                                                                                                                                                                                 || Outro start marker changes on waveform. ​                                                                                                                                            ||
 | passthrough((introduced in Mixxx v2.0.0)) ​                        || binary ​                       || Connects the vinyl control input for vinyl control on that deck to the channel output. Allows to mix external media into DJ sets.                                                                                                                                                                     || GUI control currently missing FIXME                                                                                                                                              || | passthrough((introduced in Mixxx v2.0.0)) ​                        || binary ​                       || Connects the vinyl control input for vinyl control on that deck to the channel output. Allows to mix external media into DJ sets.                                                                                                                                                                     || GUI control currently missing FIXME                                                                                                                                              ||
 | PeakIndicator ​                                                    || binary ​                       || Indicates when the signal is clipping (too loud for the hardware and is being distorted) ​                                                                                                                                                                                                             || Clip light                                                                                                                                                                       || | PeakIndicator ​                                                    || binary ​                       || Indicates when the signal is clipping (too loud for the hardware and is being distorted) ​                                                                                                                                                                                                             || Clip light                                                                                                                                                                       ||
 | pfl                                                               || binary ​                       || Toggles headphone cueing ​                                                                                                                                                                                                                                                                             || Headphone button ​                                                                                                                                                                || | pfl                                                               || binary ​                       || Toggles headphone cueing ​                                                                                                                                                                                                                                                                             || Headphone button ​                                                                                                                                                                ||
 | pitch((introduced in Mixxx v2.0.0)) ​                              || -6.0..6.0 ​                    || Changes the track pitch independent of the tempo. ​                                                                                                                                                                                                                                                    || Key display ​                                                                                                                                                                     || | pitch((introduced in Mixxx v2.0.0)) ​                              || -6.0..6.0 ​                    || Changes the track pitch independent of the tempo. ​                                                                                                                                                                                                                                                    || Key display ​                                                                                                                                                                     ||
-| pitch_up((introduced in Mixxx v2.0.0)) ​                              ​|| binary ​                    ​|| Changes the track pitch up one half step, independent of the tempo. ​                                                                                                                                                                                                                                                    ​|| Key display ​                                                                                                                                                                     || +| pitch_up((introduced in Mixxx v2.0.0)) ​                           || binary ​                       || Changes the track pitch up one half step, independent of the tempo. ​                                                                                                                                                                                                                                  ​|| Key display ​                                                                                                                                                                     || 
-| pitch_down((introduced in Mixxx v2.0.0)) ​                              ​|| binary ​                    ​|| Changes the track pitch down one half step, independent of the tempo. ​                                                                                                                                                                                                                                                    ​|| Key display ​                                                                                                                                                                     ||+| pitch_down((introduced in Mixxx v2.0.0)) ​                         || binary ​                       || Changes the track pitch down one half step, independent of the tempo. ​                                                                                                                                                                                                                                ​|| Key display ​                                                                                                                                                                     ||
 | pitch_adjust((introduced in Mixxx v2.0.0)) ​                       || -3.0..3.0 ​                    || Adjust the pitch in addition to the speed slider pitch. ​                                                                                                                                                                                                                                              || Key display ​                                                                                                                                                                     || | pitch_adjust((introduced in Mixxx v2.0.0)) ​                       || -3.0..3.0 ​                    || Adjust the pitch in addition to the speed slider pitch. ​                                                                                                                                                                                                                                              || Key display ​                                                                                                                                                                     ||
 | play                                                              || binary ​                       || Toggles playing or pausing the track. Feedback: 1.0 if track is playing or play command is adopted and track will be played after loading ​                                                                                                                                                            || Play/pause button ​                                                                                                                                                               || | play                                                              || binary ​                       || Toggles playing or pausing the track. Feedback: 1.0 if track is playing or play command is adopted and track will be played after loading ​                                                                                                                                                            || Play/pause button ​                                                                                                                                                               ||
Line 193: Line 225:
 | scratch2_enable((introduced in Mixxx v1.8.0)) ​                    || binary ​                       || Takes over play speed & direction for //​scratch2//​. ​                                                                                                                                                                                                                                                  || Waveform ​                                                                                                                                                                        || | scratch2_enable((introduced in Mixxx v1.8.0)) ​                    || binary ​                       || Takes over play speed & direction for //​scratch2//​. ​                                                                                                                                                                                                                                                  || Waveform ​                                                                                                                                                                        ||
 | slip_enabled((introduced in Mixxx v1.11.0)) ​                      || binary ​                       || Toggles slip mode. When active, the playback continues muted in the background during a loop, scratch etc. Once disabled, the audible playback will resume where the track would have been.                                                                                                           || Slip mode button ​                                                                                                                                                                || | slip_enabled((introduced in Mixxx v1.11.0)) ​                      || binary ​                       || Toggles slip mode. When active, the playback continues muted in the background during a loop, scratch etc. Once disabled, the audible playback will resume where the track would have been.                                                                                                           || Slip mode button ​                                                                                                                                                                ||
 +| stars_up((introduced in Mixxx v2.3.0)) ​                           || binary ​                       || Increase the rating of the currently loaded track (if the skin has star widgets in the decks section) ​                                                                                                                                                                                                || Star count is increased in the deck's star widget and in the library table                                                                                                        ||
 +| stars_down((introduced in Mixxx v2.3.0)) ​                         || binary ​                       || Decrease the rating of the currently loaded track (if the skin has star widgets in the decks section) ​                                                                                                                                                                                                || Star count is decreased in the deck's star widget and in the library table                                                                                                        ||
 | start                                                             || binary ​                       || Jump to start of track                                                                                                                                                                                                                                                                                || Track jumps to start                                                                                                                                                             || | start                                                             || binary ​                       || Jump to start of track                                                                                                                                                                                                                                                                                || Track jumps to start                                                                                                                                                             ||
 | start_play((introduced in Mixxx v1.10.0)) ​                        || binary ​                       || Start playback from the beginning of the deck.                                                                                                                                                                                                                                                        || Deck plays from beginning ​                                                                                                                                                       || | start_play((introduced in Mixxx v1.10.0)) ​                        || binary ​                       || Start playback from the beginning of the deck.                                                                                                                                                                                                                                                        || Deck plays from beginning ​                                                                                                                                                       ||
Line 283: Line 317:
 | AutoDjAddBottom((introduced in Mixxx v2.0.0)) ​        || Binary ​      || Add selected track(s) to Auto DJ Queue (bottom). ​                                                                                     || Append track(s) to Auto DJ playlist ​     || | AutoDjAddBottom((introduced in Mixxx v2.0.0)) ​        || Binary ​      || Add selected track(s) to Auto DJ Queue (bottom). ​                                                                                     || Append track(s) to Auto DJ playlist ​     ||
 | AutoDjAddTop((introduced in Mixxx v2.0.0)) ​           || Binary ​      || Add selected track(s) to Auto DJ Queue (top). ​                                                                                        || Prepend track(s) to Auto DJ playlist ​    || | AutoDjAddTop((introduced in Mixxx v2.0.0)) ​           || Binary ​      || Add selected track(s) to Auto DJ Queue (top). ​                                                                                        || Prepend track(s) to Auto DJ playlist ​    ||
-| show_coverart ​                                        || Binary ​      || Toggle the Cover Art in Library ​                                                                                                   |   ​|                                       ​| ​  ​|+| show_coverart ​                                        || Binary ​      || Toggle the Cover Art in Library ​                                                                                                   ||                                       ||
 | font_size_increment((introduced in Mixxx v2.0.0)) ​    || Binary ​      || Increase the size of the library font. If the row height is smaller than the font-size the larger of the two is used.                 || Library view                             || | font_size_increment((introduced in Mixxx v2.0.0)) ​    || Binary ​      || Increase the size of the library font. If the row height is smaller than the font-size the larger of the two is used.                 || Library view                             ||
 | font_size_decrement((introduced in Mixxx v2.0.0)) ​    || Binary ​      || Decrease the size of the library font                                                                                                 || Library view                             || | font_size_decrement((introduced in Mixxx v2.0.0)) ​    || Binary ​      || Decrease the size of the library font                                                                                                 || Library view                             ||
 | font_size_knob((introduced in Mixxx v2.0.0)) ​         || Relative ​    || Increase or decrease the size of the library font                                                                                     || Library view                             || | font_size_knob((introduced in Mixxx v2.0.0)) ​         || Relative ​    || Increase or decrease the size of the library font                                                                                     || Library view                             ||
 +| sort_column((introduced in Mixxx v2.3.0)) ​            || See table below    || Indicates the sorting column the track table || Sorting indicator in the column headers of the track table ||
 +| sort_column_toggle((introduced in Mixxx v2.3.0)) ​            || See table below    || Equivalent to clicking on column headers. A new value sets sort_column to that value and sort_order to 0, setting the same value again will toggle sort_order. || Sorting indicator in the column headers of the track table ||
 +| sort_order((introduced in Mixxx v2.3.0)) ​             || Binary ​      || Indicate the sort order of the track table (0 for ascending, 1 for descending) || Sorting indicator in the column headers of the track table ||
 +
 +=== Allowed values for sort_column/​sort_column_toggle ===
 +
 +^             ​^ ​             ^  Availability ​                   ||||
 +^ Index ^ Description ​       ^ Library ^ Playlist ^ Crate ^ Browse |
 +|     0 | Artist ​            ​| ​ X      |  X       ​| ​ X    |  X     |
 +|     1 | Title              |  X      |  X       ​| ​ X    |  X     |
 +|     2 | Album              |  X      |  X       ​| ​ X    |  X     |
 +|     3 | Albumartist ​       |  X      |  X       ​| ​ X    |  X     |
 +|     4 | Year               ​| ​ X      |  X       ​| ​ X    |  X     |
 +|     5 | Genre              |  X      |  X       ​| ​ X    |  X     |
 +|     6 | Composer ​          ​| ​ X      |  X       ​| ​ X    |  X     |
 +|     7 | Grouping ​          ​| ​ X      |  X       ​| ​ X    |  X     |
 +|     8 | Tracknumber ​       |  X      |  X       ​| ​ X    |  X     |
 +|     9 | Filetype ​          ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    10 | Native Location ​   |  X      |  X       ​| ​ X    |  X     |
 +|    11 | Comment ​           |  X      |  X       ​| ​ X    |  X     |
 +|    12 | Duration ​          ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    13 | Bitrate ​           |  X      |  X       ​| ​ X    |  X     |
 +|    14 | BPM                |  X      |  X       ​| ​ X    |  X     |
 +|    15 | ReplayGain ​        ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    16 | Datetime Added     ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    17 | Times Played ​      ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    18 | Rating ​            ​| ​ X      |  X       ​| ​ X    |  X     |
 +|    19 | Key                |  X      |  X       ​| ​ X    |  X     |
 +|    20 | Preview ​           |  X      |  X       ​| ​ X    |  X     |
 +|    21 | Coverart ​          ​| ​ X      |  X       ​| ​ X    |        |
 +|    22 | Position ​          ​| ​        ​| ​ X       ​| ​      ​| ​       |
 +|    23 | Playlist ID        |         ​| ​ X       ​| ​      ​| ​       |
 +|    24 | Location ​          ​| ​        ​| ​ X       ​| ​      ​| ​       |
 +|    25 | Filename ​          ​| ​        ​| ​         |       ​| ​ X     |
 +|    26 | File Modified Time |         ​| ​         |       ​| ​ X     |
 +|    27 | File Creation Time |         ​| ​         |       ​| ​ X     |
  
 ==== [Playlist] ==== ==== [Playlist] ====
Line 297: Line 367:
 ^^Key/​Control^^Range^^What it does^^On-screen feedback^^ ^^Key/​Control^^Range^^What it does^^On-screen feedback^^
 ||touch_shift((introduced in Mixxx v2.0.0))||binary||Once enabled, all touch tab events are interpreted as right click. This control has been added to provide touchscreen compatibility in 2.0 and might be replaced by a general modifier solution in the future.||All Widgets|| ||touch_shift((introduced in Mixxx v2.0.0))||binary||Once enabled, all touch tab events are interpreted as right click. This control has been added to provide touchscreen compatibility in 2.0 and might be replaced by a general modifier solution in the future.||All Widgets||
 +||AutoHotcueColors((introduced in Mixxx v2.3.0))||binary||If enabled, colors will be assigned to newly created hot cue points automatically.||N/​A||
  
 ==== Effects framework ==== ==== Effects framework ====
Line 310: Line 381:
 | [EffectRack1_EffectUnitN] ​                                           || clear                         || binary ​                  || Clear the currently loaded EffectChain in this EffectUnit. ​                                                                                                                                           || | [EffectRack1_EffectUnitN] ​                                           || clear                         || binary ​                  || Clear the currently loaded EffectChain in this EffectUnit. ​                                                                                                                                           ||
 | [EffectRack1_EffectUnitN] ​                                           || enabled ​                      || binary, default true     || If true, the EffectChain in this EffectUnit will be processed. Meant to allow the user a quick toggle for the effect unit.                                                                            || | [EffectRack1_EffectUnitN] ​                                           || enabled ​                      || binary, default true     || If true, the EffectChain in this EffectUnit will be processed. Meant to allow the user a quick toggle for the effect unit.                                                                            ||
-| [EffectRack1_EffectUnitN] ((introduced in Mixxx v2.1.0)) ​            || focused_effect ​               || 0..num_effects ​          || 0 indicates no effect is focused; >0 indicates the number ​of the focused effect. Focusing an effect only does something if a controller mapping changes how it behaves when an effect is focused. ​    ||+| [EffectRack1_EffectUnitN] ((introduced in Mixxx v2.1.0)) ​            || focused_effect ​               || 0..num_effects ​          || 0 indicates no effect is focused; > 0 indicates the index of the focused effect. Focusing an effect only does something if a controller mapping changes how it behaves when an effect is focused. ​    ||
 | [EffectRack1_EffectUnitN] ​                                           || group_[ChannelI]_enable ​      || binary ​                  || Whether or not this EffectChain applies to Deck I                                                                                                                                                     || | [EffectRack1_EffectUnitN] ​                                           || group_[ChannelI]_enable ​      || binary ​                  || Whether or not this EffectChain applies to Deck I                                                                                                                                                     ||
 | [EffectRack1_EffectUnitN] ​                                           || group_[Headphone]_enable ​     || binary ​                  || Whether or not this EffectChain applies to the Headphone output ​                                                                                                                                      || | [EffectRack1_EffectUnitN] ​                                           || group_[Headphone]_enable ​     || binary ​                  || Whether or not this EffectChain applies to the Headphone output ​                                                                                                                                      ||
Line 373: Line 444:
  
 ==== EQs and filters ==== ==== EQs and filters ====
-Starting in Mixxx 2.0, the equalizers and filter controls have been moved to special [[#effects framework|effects units]]. The EQs are controlled by [EqualizerRack1_[Channel//​N//​]_Effect1] and the filter knob is controlled by [QuickEffectRack1_[Channel//​N//​]],​super and [QuickEffectRack1_[ChannelN]_Effect1],​enabled. Users can choose between several options for the effects loaded in these racks in the Equalizers section of the Preferences window.+Starting in Mixxx 2.0, the equalizers and filter controls have been moved to special [[#effects framework|effects units]]. The EQs are controlled by [EqualizerRack1_[Channel//​N//​]_Effect1] and the filter knob is controlled by [QuickEffectRack1_[Channel//​N//​]],​super1 ​and [QuickEffectRack1_[ChannelN]_Effect1],​enabled. Users can choose between several options for the effects loaded in these racks in the Equalizers section of the Preferences window.
  
 ==== Deprecated controls ==== ==== Deprecated controls ====
Line 381: Line 452:
 | [Channel//​N//​] ​    || reloop_exit ​                                                                 || binary ​                  || Toggles the current loop on or off. If the loop is ahead of the current play position, the track will keep playing normally until it reaches the loop.     || Loop range in waveform activates or deactivates. ​    || reloop_toggle ​                                                                    || | [Channel//​N//​] ​    || reloop_exit ​                                                                 || binary ​                  || Toggles the current loop on or off. If the loop is ahead of the current play position, the track will keep playing normally until it reaches the loop.     || Loop range in waveform activates or deactivates. ​    || reloop_toggle ​                                                                    ||
 | [Channel//​N//​] ​    || scratch ​                                                                     || -3.0..3.0 ​               || Affects play speed & direction ([[https://​bugs.launchpad.net/​mixxx/​+bug/​530281|differently whether currently playing or not]]) (multiplicative) ​           || Waveform ​                                            || [[MIDI scripting#​scratching|JavaScript engine.scratch functions]] ​                || | [Channel//​N//​] ​    || scratch ​                                                                     || -3.0..3.0 ​               || Affects play speed & direction ([[https://​bugs.launchpad.net/​mixxx/​+bug/​530281|differently whether currently playing or not]]) (multiplicative) ​           || Waveform ​                                            || [[MIDI scripting#​scratching|JavaScript engine.scratch functions]] ​                ||
-| [Channel//​N//​] ​    || filter((introduced in Mixxx v2.0.0)),​((deprecated in Mixxx v2.0.0)) ​         || binary ​                  || Toggles the filter effect ​                                                                                                                                 || Filter button ​                                       || [[#effects framework|[QuickEffectRack1_[ChannelN]_Effect1]],​ enabled ​                     || +| [Channel//​N//​] ​    || filter((introduced in Mixxx v2.0.0)),​((deprecated in Mixxx v2.0.0)) ​         || binary ​                  || Toggles the filter effect ​                                                                                                                                 || Filter button ​                                       || [[#effects framework|[QuickEffectRack1_[ChannelN]_Effect1]]], enabled ​            ​|| 
-| [Channel//​N//​] ​    || filterDepth((introduced in Mixxx v2.0.0)),​((deprecated in Mixxx v2.0.0)) ​    || default ​                 || Adjusts the intensity of the filter effect ​                                                                                                                || Filter depth knob                                    || [[#effects framework|[QuickEffectRack1_[ChannelN]]],​ super1 ​                      ​||+| [Channel//​N//​] ​    || filterDepth((introduced in Mixxx v2.0.0)),​((deprecated in Mixxx v2.0.0)) ​    || default ​                 || Adjusts the intensity of the filter effect ​                                                                                                                || Filter depth knob                                    || [[#effects framework|[QuickEffectRack1_[ChannelN]]]], super1 ​                     ||
 | [Channel//​N//​] ​    || filterLow((deprecated in Mixxx v2.0.0)) ​                                     || 0.0..1.0..4.0 ​           || Adjusts the gain of the low EQ filter ​                                                                                                                     || LOW knob                                             || [[#effects framework|[EqualizerRack1_[ChannelN]_Effect1]]],​ parameter1 ​           || | [Channel//​N//​] ​    || filterLow((deprecated in Mixxx v2.0.0)) ​                                     || 0.0..1.0..4.0 ​           || Adjusts the gain of the low EQ filter ​                                                                                                                     || LOW knob                                             || [[#effects framework|[EqualizerRack1_[ChannelN]_Effect1]]],​ parameter1 ​           ||
 | [Channel//​N//​] ​    || filterLowKill((deprecated in Mixxx v2.0.0)) ​                                 || binary ​                  || Holds the gain of the low EQ to -inf while active ​                                                                                                         || LOW kill knob                                        || [[#effects framework|[EqualizerRack1_[ChannelN]_Effect1]]],​ button_parameter1 ​    || | [Channel//​N//​] ​    || filterLowKill((deprecated in Mixxx v2.0.0)) ​                                 || binary ​                  || Holds the gain of the low EQ to -inf while active ​                                                                                                         || LOW kill knob                                        || [[#effects framework|[EqualizerRack1_[ChannelN]_Effect1]]],​ button_parameter1 ​    ||
Line 411: Line 482:
 | [Playlist] ​        || SelectNextTrack ​                                                             || binary ​                  || Scrolls to the next track in the track table. ​                                                                                                             || Library track table highlight ​                       || [Library] MoveDown ​                                                               || | [Playlist] ​        || SelectNextTrack ​                                                             || binary ​                  || Scrolls to the next track in the track table. ​                                                                                                             || Library track table highlight ​                       || [Library] MoveDown ​                                                               ||
 | [Playlist] ​        || SelectPrevTrack ​                                                             || binary ​                  || Scrolls to the previous track in the track table. ​                                                                                                         || Library track table highlight ​                       || [Library] MoveUp ​                                                                 || | [Playlist] ​        || SelectPrevTrack ​                                                             || binary ​                  || Scrolls to the previous track in the track table. ​                                                                                                         || Library track table highlight ​                       || [Library] MoveUp ​                                                                 ||
- 
  
mixxxcontrols.txt · Last modified: 2019/08/17 13:46 by be.ing