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
mixxxcontrols [2019/04/27 05:40]
jus
mixxxcontrols [2019/06/12 03:57] (current)
hlzhs [[Library]]
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 287: Line 297:
 | 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 301: Line 347:
 ^^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 ====
mixxxcontrols.1556358051.txt.gz ยท Last modified: 2019/04/27 05:40 by jus