diff --git a/source/chapters/appendix/mixxx_controls.rst b/source/chapters/appendix/mixxx_controls.rst index 57d2a2d742..87bc1f61a1 100644 --- a/source/chapters/appendix/mixxx_controls.rst +++ b/source/chapters/appendix/mixxx_controls.rst @@ -99,6 +99,108 @@ To use ``*_toggle`` the respective shortcut for scripts is: script.toggleControl(group, "keylock_toggle", 100); +The ``[App]`` group +~~~~~~~~~~~~~~~~~~~ + +The :mixxx:cogroupref:`[App]` group contains controls that do not belong to a specific channel, the mixer or the effects engine. + +.. mixxx:control:: [App],indicator_250ms + + Alternates between 0.0 and 1.0 every 250 milliseconds. + + This control may be used to implement a blinking LED in JavaScript and is + guaranteed to light up at the same time as + :mixxx:coref:`[ChannelN],cue_indicator` and + :mixxx:coref:`[ChannelN],play_indicator` when these are blinking (depending + on the currently chosen :ref:`cue mode `). + + :range: binary, read-only + :feedback: None + + .. versionadded:: 2.4.0 + +.. mixxx:control:: [App],indicator_500ms + + Alternates between 0.0 and 1.0 every 500 milliseconds. + + This control may be used to implement a blinking LED in JavaScript and is + guaranteed to light up at the same time as + :mixxx:coref:`[ChannelN],cue_indicator` and + :mixxx:coref:`[ChannelN],play_indicator` when these are blinking (depending + on the currently chosen :ref:`cue mode `). + + :range: binary, read-only + :feedback: None + + .. versionadded:: 2.4.0 + + +.. mixxx:control:: [App],num_decks + + The number of decks currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],num_decks` control. + + +.. mixxx:control:: [App],num_samplers + + The number of samplers currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],num_samplers` control. + + +.. mixxx:control:: [App],num_preview_decks + + The number of preview decks currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],num_preview_decks` control. + +.. mixxx:control:: [App],num_microphones + + The number of microphone inputs that can be configured. + + :range: integer + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],num_microphones` control. + + +.. mixxx:control:: [App],num_auxiliaries + + The number of auxiliary inputs that can be configured. + + :range: integer + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],num_auxiliaries` control. + + +.. mixxx:control:: [App],samplerate + + The current output sample rate (default: 44100 Hz). + + :range: absolute value (in Hz) + :feedback: None + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],samplerate` control. + + + The ``[Master]`` group ~~~~~~~~~~~~~~~~~~~~~~ @@ -293,35 +395,6 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:` .. versionadded:: 2.0.0 -.. mixxx:control:: [Master],indicator_250millis - - Alternates between 0.0 and 1.0 every 250 milliseconds. - - This control may be used to implement a blinking LED in JavaScript and is - guaranteed to light up at the same time as - :mixxx:coref:`[ChannelN],cue_indicator` and - :mixxx:coref:`[ChannelN],play_indicator` when these are blinking (depending - on the currently chosen :ref:`cue mode `). - - :range: binary, read-only - :feedback: None - - .. versionadded:: 2.4.0 - -.. mixxx:control:: [Master],indicator_500millis - - Alternates between 0.0 and 1.0 every 500 milliseconds. - - This control may be used to implement a blinking LED in JavaScript and is - guaranteed to light up at the same time as - :mixxx:coref:`[ChannelN],cue_indicator` and - :mixxx:coref:`[ChannelN],play_indicator` when these are blinking (depending - on the currently chosen :ref:`cue mode `). - - :range: binary, read-only - :feedback: None - - .. versionadded:: 2.4.0 .. mixxx:control:: [Master],latency @@ -331,26 +404,6 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:` :feedback: Latency slider in the prefs -.. mixxx:control:: [Master],maximize_library - - Toggle maximized view of library. - - :range: binary - :feedback: Toggle maximized view of library - - .. versionadded:: 2.0.0 - - -.. mixxx:control:: [Master],num_decks - - The number of decks currently enabled. - - :range: integer - :feedback: None - - .. versionadded:: 1.9.0 - - .. mixxx:control:: [Master],num_effectsavailable The number of available effects that can be selected in an effect slot. @@ -361,26 +414,6 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:` .. versionadded:: 2.1.0 -.. mixxx:control:: [Master],num_samplers - - The number of samplers currently enabled. - - :range: integer - :feedback: None - - .. versionadded:: 1.9.0 - - -.. mixxx:control:: [Master],num_preview_decks - - The number of preview decks currently enabled. - - :range: integer - :feedback: None - - .. versionadded:: 1.11.0 - - .. mixxx:control:: [Master],PeakIndicator Indicates when the signal is clipping (too loud for the hardware and is being distorted) (composite). @@ -411,14 +444,6 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:` :feedback: Clip light (right) -.. mixxx:control:: [Master],samplerate - - The current output sample rate (default: 44100 Hz). - - :range: absolute value (in Hz) - :feedback: None - - .. mixxx:control:: [Master],talkoverDucking Toggle microphone ducking mode (OFF, AUTO, MANUAL) @@ -459,27 +484,6 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:` :feedback: Main meter R -.. mixxx:control:: [Master],headVolume - - Adjust headphone volume. - - :range: 0.0..1.0..5.0 - :feedback: Headphone Gain knob - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[Master],headGain` instead. - - -.. mixxx:control:: [Master],volume - - Adjust main volume. - - :range: 0.0..1.0..5.0 - :feedback: Main Gain knob - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[Master],gain` instead. - .. _appendix-mixxxcontrols-decks: Decks, Preview Decks and Samplers @@ -881,7 +885,7 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp Clone the given sampler number, copying the play state, position, rate, and key. - :range: integer between 1 and :mixxx:coref:`[Master],num_samplers` (inclusive) + :range: integer between 1 and :mixxx:coref:`[App],num_samplers` (inclusive) :feedback: The channel will start playing at the rate and position of the source deck. .. versionadded:: 2.3.0 @@ -893,7 +897,7 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp Load the track currently loaded to the given deck number. - :range: integer between 1 and :mixxx:coref:`[Master],num_decks` (inclusive) + :range: integer between 1 and :mixxx:coref:`[App],num_decks` (inclusive) :feedback: Track name & waveform change .. versionadded:: 2.4.0 @@ -905,7 +909,7 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp Load the track currently loaded to the given sampler number. - :range: integer between 1 and :mixxx:coref:`[Master],num_samplers` (inclusive) + :range: integer between 1 and :mixxx:coref:`[App],num_samplers` (inclusive) :feedback: Track name & waveform change .. versionadded:: 2.4.0 @@ -1223,28 +1227,6 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp .. versionadded:: 2.3.0 -.. mixxx:control:: [ChannelN],hotcue_X_enabled - [PreviewDeckN],hotcue_X_enabled - [SamplerN],hotcue_X_enabled - - Indicates if :term:`hotcue` slot X is set, active or empty. - - :range (read-only): - ===== =================================== - Value Meaning - ===== =================================== - 0 Hotcue X is not set - 1 Hotcue X is set - 2 Hotcue X is active (saved loop is enabled or hotcue is previewing) - ===== =================================== - - .. versionadded:: 1.8.0 - .. versionchanged:: 2.4.0 - Added support for "active" state. - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[ChannelN],hotcue_X_status` instead. - - .. mixxx:control:: [ChannelN],hotcue_X_status [PreviewDeckN],hotcue_X_status [SamplerN],hotcue_X_status @@ -2513,16 +2495,6 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp .. versionadded:: 2.4.0 -.. mixxx:control:: [ChannelN],sync_master - [PreviewDeckN],sync_master - [SamplerN],sync_master - - .. versionadded:: 2.0.0 - .. versionchanged:: 2.3.0 - This button just enables :term:`sync lock` mode (similar to :mixxx:coref:`[ChannelN],sync_enabled`), it does not actually guarantee the deck will be the sync leader. This will be fixed in a future version. - - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[ChannelN],sync_leader`, :mixxx:coref:`[PreviewDeckN],sync_leader` and :mixxx:coref:`[SamplerN],sync_leader` instead. .. mixxx:control:: [ChannelN],sync_mode [PreviewDeckN],sync_mode @@ -2830,218 +2802,41 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp :feedback: Waveform -Deprecated controls -+++++++++++++++++++ +.. _appendix-mixxxcontrols-samplers: -These controls have been deprecated, new controller mappings should use the alternatives. +Global Sampler controls ++++++++++++++++++++++++ -.. mixxx:control:: [ChannelN],beatloop - [PreviewDeckN],beatloop - [SamplerN],beatloop +These controls can be used to control all samplers. - Setup a loop over the set number of beats. +.. mixxx:control:: [Sampler],SaveSamplerBank - :range: positive real number - :feedback: A loop is shown over the set number of beats. + Save sampler configuration. Make currently loaded tracks in samplers instantly available at a later point. - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[ChannelN],beatloop_size` and `[ChannelN],beatloop_toggle` instead. + :range: binary + :feedback: Opens file dialog. Configuration file can be named and saved. + .. versionadded:: 2.0.0 -.. mixxx:control:: [ChannelN],reloop_exit - [PreviewDeckN],reloop_exit - [SamplerN],reloop_exit - 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. +.. mixxx:control:: [Sampler],LoadSamplerBank - :range: binary - :feedback: Loop range in waveform activates or deactivates. + Load saved sampler configuration file and add tracks to the available samplers. - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[ChannelN],reloop_toggle` instead. + :range: binary + :feedback: Opens file dialog. Select configuration file. + .. versionadded:: 2.0.0 -.. mixxx:control:: [ChannelN],jog - [PreviewDeckN],jog - [SamplerN],jog - Affects relative playback speed and direction for short instances (additive & is automatically reset to 0). +.. seealso:: + The :mixxx:coref:`[Skin],show_samplers` control can be used to show and hide sampler banks in the GUI. - :range: -3.0..3.0 - :feedback: waveform - .. deprecated:: ?? - Use the JavaScript ``engine.scratch`` functions instead. +.. _appendix-mixxxcontrols-aux: - -.. mixxx:control:: [ChannelN],scratch - [PreviewDeckN],scratch - [SamplerN],scratch - - Affects playback speed and direction ([differently whether currently playing or not](https://github.com/mixxxdj/mixxx/issues/5350)) (multiplicative). - - :range: -3.0..3.0 - :feedback: Waveform - - .. deprecated:: ?? - Use the JavaScript ``engine.scratch`` functions instead. - - -.. mixxx:control:: [ChannelN],filter - [PreviewDeckN],filter - [SamplerN],filter - - Toggles the filter effect. - - :range: binary - :feedback: Filter button - - .. versionadded:: 2.0.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]_Effect1],enabled <[QuickEffectRack1_[ChannelI]_Effect1],enabled>` instead. - - -.. mixxx:control:: [ChannelN],filterDepth - [PreviewDeckN],filterDepth - [SamplerN],filterDepth - - Adjusts the intensity of the filter effect. - - :range: default - :feedback: Filter depth knob - - .. versionadded:: 2.0.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]],super1 <[QuickEffectRack1_[ChannelI]],super1>` instead. - - -.. mixxx:control:: [ChannelN],filterLow - [PreviewDeckN],filterLow - [SamplerN],filterLow - - Adjusts the gain of the low :term:`EQ` filter. - - :range: 0.0..1.0..4.0 - :feedback: Low EQ knob - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelN]_Effect1],parameter1 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. - - -.. mixxx:control:: [ChannelN],filterLowKill - [PreviewDeckN],filterLowKill - [SamplerN],filterLowKill - - Holds the gain of the low :term:`EQ` to -inf while active - - :range: binary - :feedback: Low EQ :term:`kill switch` - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter1 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. - - -.. mixxx:control:: [ChannelN],filterMid - [PreviewDeckN],filterMid - [SamplerN],filterMid - - Adjusts the gain of the mid :term:`EQ` filter.. - - :range: 0.0..1.0..4.0 - :feedback: Mid EQ knob - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],parameter2 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. - - -.. mixxx:control:: [ChannelN],filterMidKill - [PreviewDeckN],filterMidKill - [SamplerN],filterMidKill - - Holds the gain of the mid :term:`EQ` to -inf while active. - - :range: binary - :feedback: Mid EQ :term:`kill switch` - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter2 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. - - -.. mixxx:control:: [ChannelN],filterHigh - [PreviewDeckN],filterHigh - [SamplerN],filterHigh - - Adjusts the gain of the high :term:`EQ` filter. - - :range: 0.0..1.0..4.0 - :feedback: High EQ knob - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],parameter3 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. - - -.. mixxx:control:: [ChannelN],filterHighKill - [PreviewDeckN],filterHighKill - [SamplerN],filterHighKill - - Holds the gain of the high :term:`EQ` to -inf while active. - - :range: binary - :feedback: High EQ :term:`kill switch` - - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter3 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. - - -.. mixxx:control:: [ChannelN],beatloop_X - [PreviewDeckN],beatloop_X - [SamplerN],beatloop_X - - Setup a loop over X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64 - - :range: toggle - :feedback: A loop is shown over X beats. - - .. versionadded:: 1.10.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[ChannelN],beatloop_X_activate` instead. - -.. _appendix-mixxxcontrols-samplers: - -Global Sampler controls -+++++++++++++++++++++++ - -These controls can be used to control all samplers. - -.. mixxx:control:: [Samplers],show_samplers - - :range: binary - :feedback: Shows Sampler bank(s) - -.. mixxx:control:: [Sampler],SaveSamplerBank - - Save sampler configuration. Make currently loaded tracks in samplers instantly available at a later point. - - :range: binary - :feedback: Opens file dialog. Configuration file can be named and saved. - - .. versionadded: 2.0.0 - - -.. mixxx:control:: [Sampler],LoadSamplerBank - - Load saved sampler configuration file and add tracks to the available samplers. - - :range: binary - :feedback: Opens file dialog. Select configuration file. - - .. versionadded: 2.0.0 - - -.. _appendix-mixxxcontrols-aux: - -Microphones and Auxiliary Channels -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Microphones and Auxiliary Channels +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In contrast to :ref:`decks, preview decks and samplers `, microphones and auxiliary channels are input channels. You can map audio interface's inputs to mixxx's auxiliary input channels and connect external audio source to it (cellphone, mp3 player). @@ -3049,19 +2844,6 @@ Then you can use your :term:`MIDI` controller to control its volume and some oth .. note:: Although the first auxiliary group is named :mixxx:cogroupref:`[Auxiliary1]`, the group for the first microphone is just called :mixxx:cogroupref:`[Microphone] <[MicrophoneN]>`, not :mixxx:cogroupref:`[Microphone1] <[MicrophoneN]>`. -.. mixxx:control:: [MicrophoneN],enabled - [AuxiliaryN],enabled - - 1 if a channel input is enabled, 0 if not. - - :range: binary - :feedback: Microphone is enabled. - - .. versionadded:: 1.10.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[MicrophoneN],input_configured` instead. - - .. mixxx:control:: [MicrophoneN],input_configured [AuxiliaryN],input_configured @@ -3082,12 +2864,6 @@ Then you can use your :term:`MIDI` controller to control its volume and some oth :feedback: Auxiliary: Play button Microphone: N/A -.. mixxx:control:: [MicrophoneN],master - [AuxiliaryN],master - - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[MicrophoneN],main_mix` instead. - .. mixxx:control:: [AuxiliaryN],orientation Set channel orientation for the :term:`crossfader`. @@ -3104,14 +2880,6 @@ Then you can use your :term:`MIDI` controller to control its volume and some oth .. versionadded:: 1.10.0 -.. mixxx:control:: [MicrophoneN],orientation - - .. versionadded:: 1.10.0 - .. deprecated:: 1.10.0 - - The control is not processed in the Mixer, which is also why there are no orientation controls for Microphones in the GUI. - - .. mixxx:control:: [MicrophoneN],PeakIndicator [AuxiliaryN],PeakIndicator @@ -3262,16 +3030,6 @@ The :mixxx:cogroupref:`[VinylControl]` group can toggle the :ref:`vinyl control .. versionadded:: 1.10.0 -.. mixxx:control:: [VinylControl],show_vinylcontrol - - Toggle the vinyl control section in skins. - - :range: binary - :feedback: Vinyl controls are shown - - .. versionadded:: 1.10.0 - - .. mixxx:control:: [VinylControl],gain Allows to amplify the "phono" level of attached turntables to "line" level. @@ -3282,6 +3040,11 @@ The :mixxx:cogroupref:`[VinylControl]` group can toggle the :ref:`vinyl control .. versionadded:: 1.10.0 + +.. seealso:: + The :mixxx:coref:`[Skin],show_vinylcontrol` control can be used to show and hide :ref:`vinyl control` related elements in the GUI. + + The ``[Recording]`` controls ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3590,13 +3353,6 @@ Note that :mixxx:coref:`[Library],MoveUp` and other Move and Scroll controls emu .. versionadded:: 2.0.0 -.. mixxx:control:: [Library],show_coverart - - Toggle the Cover Art in Library - - :range: Binary - - .. mixxx:control:: [Library],font_size_increment Increase the size of the library font. If the row height is smaller than the font-size the larger of the two is used. @@ -3765,6 +3521,13 @@ Note that :mixxx:coref:`[Library],MoveUp` and other Move and Scroll controls emu .. versionadded:: 2.4.0 + +.. seealso:: + The library section in the GUI can be enlarged by using the :mixxx:coref:`[Skin],show_maximized_library` control. + + The :mixxx:coref:`[Skin],show_library_coverart` control can be used to toggle the display of library coverart. + + The ``[Shoutcast]`` controls ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3811,96 +3574,33 @@ This group is going to be deprecated at some point, with its controls added to ` :feedback: Library track table highlight -.. mixxx:control:: [Playlist],LoadSelectedIntoFirstStopped - :range: binary - :feedback: Waveform view - - Loads the currently highlighted song into the first stopped deck +The ``[Controls]`` controls +~~~~~~~~~~~~~~~~~~~~~~~~~~~ - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],GoToItem` instead. +The :mixxx:cogroupref:`[Controls]` group contains controls that didn't fit in any other group. +.. mixxx:control:: [Controls],touch_shift -.. mixxx:control:: [Playlist],SelectNextPlaylist - :range: binary - :feedback: Library sidebar + 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. - Switches to the next view (Library, Queue, etc.) + :range: binary + :feedback: All Widgets - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],MoveDown` instead. + .. versionadded:: 2.0.0 -.. mixxx:control:: [Playlist],SelectPrevPlaylist +.. mixxx:control:: [Controls],AutoHotcueColors - :range: binary - :feedback: Library sidebar + If enabled, colors will be assigned to newly created :term:`hotcues ` automatically. - Switches to the previous view (Library, Queue, etc.) + :range: binary + :feedback: None - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],MoveUp` instead. + .. versionadded:: 2.3.0 +.. mixxx:control:: [Controls],ShowDurationRemaining -.. mixxx:control:: [Playlist],ToggleSelectedSidebarItem - :range: binary - :feedback: Library sidebar - - Toggles (expands/collapses) the currently selected sidebar item. - - .. versionadded:: 1.11.0 - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],GoToItem` instead. - - -.. mixxx:control:: [Playlist],SelectNextTrack - :range: binary - :feedback: Library track table highlight - - Scrolls to the next track in the track table. - - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],MoveDown` instead. - - -.. mixxx:control:: [Playlist],SelectPrevTrack - :range: binary - :feedback: Library track table highlight - - Scrolls to the previous track in the track table. - - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[Library],MoveUp` instead. - - - -The ``[Controls]`` controls -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The :mixxx:cogroupref:`[Controls]` group contains controls that didn't fit in any other group. - -.. mixxx:control:: [Controls],touch_shift - - 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. - - :range: binary - :feedback: All Widgets - - .. versionadded:: 2.0.0 - - -.. mixxx:control:: [Controls],AutoHotcueColors - - If enabled, colors will be assigned to newly created :term:`hotcues ` automatically. - - :range: binary - :feedback: None - - .. versionadded:: 2.3.0 - -.. mixxx:control:: [Controls],ShowDurationRemaining - - Represents the current state of the remaining time duration display of the loaded track. + Represents the current state of the remaining time duration display of the loaded track. :range: ===== =========================================================================== @@ -3923,8 +3623,8 @@ In the list below, * N ranges from 1 to ``[EffectRack1],num_effectunits``, inclusive. * M ranges from 1 to ``[EffectRack1_EffectUnitN],num_effectslots``, inclusive. (For a given value of N) * K ranges from 1 to ``[EffectRack1_EffectUnitN_EffectM],num_parameters``, inclusive. (For given values of N and M) - * I ranges from 1 to ``[Master],num_decks``, inclusive. - * J ranges from 1 to ``[Master],num_samplers``, inclusive. + * I ranges from 1 to ``[App],num_decks``, inclusive. + * J ranges from 1 to ``[App],num_samplers``, inclusive. .. versionadded:: 2.0.0 @@ -3964,13 +3664,6 @@ Users can choose between several options for the effects loaded in these racks i Controls ++++++++ -.. mixxx:control:: [EffectRack1],show - - Show the Effect Rack - - :range: binary - - .. mixxx:control:: [EffectRack1],num_effectunits [EqualizerRack1],num_effectunits [QuickEffectRack1],num_effectunits @@ -4307,6 +4000,537 @@ Controls :range: integer, read-only +.. seealso:: + The :mixxx:coref:`[EffectRack1],show` control can be used to show and hide the effect section in the GUI. + + +The ``[Skin]`` group +~~~~~~~~~~~~~~~~~~~~ + +The :mixxx:cogroupref:`[Skin]` group contains controls that are used to selective show and hide parts of the :term:`graphical user interface ` of Mixxx to suit your needs. + +.. note:: + Some skins may not support some or all of these controls. + In this case, triggering the unsupported control will do nothing. + +.. mixxx:control:: [Skin],show_effectrack + + Toggle the display of the effect rack in the :term:`user interface `. + + :range: binary + :feedback: Effect rack is shown/hidden. + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[EffectRack1],show` control. + + +.. mixxx:control:: [Skin],show_library_coverart + + Toggle the display of cover art in the library section of the :term:`user interface `. + + :range: binary + :feedback: Cover art in the library is shown/hidden. + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Library],show_coverart` control. + + +.. mixxx:control:: [Skin],show_maximized_library + + Toggle maximized view of library section of the :term:`user interface `. + + :range: binary + :feedback: The library section of the user interface is enlarged/shrunk. + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Master],maximize_library` control. + + +.. mixxx:control:: [Skin],show_samplers + + Toggle the display of sampler banks in the :term:`user interface `. + + :range: binary + :feedback: Sampler banks are shown/hidden. + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[Samplers],show_samplers` control. + + +.. mixxx:control:: [Skin],show_vinylcontrol + + Toggle the :ref:`vinyl control ` section in the :term:`user interface `. + + :range: binary + :feedback: Vinyl controls are shown/hidden. + + .. versionadded:: 2.4.0 + Replaces the deprecated :mixxx:coref:`[VinylControl],show_vinylcontrol` control. + + +Deprecated controls +~~~~~~~~~~~~~~~~~~~ + +These controls have been deprecated and may be removed in a future version of Mixxx. +In the meantime, skins and controller mappings that still use them will keep working, but using the suggested alternatives is strongly recommended. + + +.. mixxx:control:: [Master],num_decks + + The number of decks currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 1.9.0 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],num_decks` instead. + + +.. mixxx:control:: [Master],num_samplers + + The number of samplers currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 1.9.0 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],num_samplers` instead. + + +.. mixxx:control:: [Master],num_preview_decks + + The number of preview decks currently enabled. + + :range: integer + :feedback: None + + .. versionadded:: 1.9.0 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],num_preview_decks` instead. + + +.. mixxx:control:: [Master],num_microphones + + The number of microphone inputs that can be configured. + + :range: integer + :feedback: None + + .. versionadded:: 2.2.4 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],num_microphones` instead. + + +.. mixxx:control:: [Master],num_auxiliaries + + The number of auxiliary inputs that can be configured. + + :range: integer + :feedback: None + + .. versionadded:: 2.2.4 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],num_auxiliaries` instead. + + +.. mixxx:control:: [Master],samplerate + + The current output sample rate (default: 44100 Hz). + + :range: absolute value (in Hz) + :feedback: None + + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[App],samplerate` instead. + + +.. mixxx:control:: [Master],headVolume + + Adjust headphone volume. + + :range: 0.0..1.0..5.0 + :feedback: Headphone Gain knob + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[Master],headGain` instead. + + +.. mixxx:control:: [Master],volume + + Adjust main volume. + + :range: 0.0..1.0..5.0 + :feedback: Main Gain knob + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[Master],gain` instead. + + +.. mixxx:control:: [Master],maximize_library + + Toggle maximized view of library. + + :range: binary + :feedback: Toggle maximized view of library + + .. versionadded:: 2.0.0 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[Skin],show_maximized_library` instead. + + +.. mixxx:control:: [Samplers],show_samplers + + :range: binary + :feedback: Shows Sampler bank(s) + + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[Skin],show_samplers` instead. + + +.. mixxx:control:: [VinylControl],show_vinylcontrol + + Toggle the vinyl control section in skins. + + :range: binary + :feedback: Vinyl controls are shown + + .. versionadded:: 1.10.0 + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[Skin],show_vinylcontrol` instead. + + +.. mixxx:control:: [Library],show_coverart + + Toggle the Cover Art in Library + + :range: Binary + + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[Skin],show_library_coverart` instead. + + +.. mixxx:control:: [EffectRack1],show + + Show the Effect Rack + + :range: binary + + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[Skin],show_effectrack` instead. + + +.. mixxx:control:: [ChannelN],hotcue_X_enabled + [PreviewDeckN],hotcue_X_enabled + [SamplerN],hotcue_X_enabled + + Indicates if :term:`hotcue` slot X is set, active or empty. + + :range (read-only): + + ===== =================================== + Value Meaning + ===== =================================== + 0 Hotcue X is not set + 1 Hotcue X is set + 2 Hotcue X is active (saved loop is enabled or hotcue is previewing) + ===== =================================== + + .. versionadded:: 1.8.0 + .. versionchanged:: 2.4.0 + Added support for "active" state. + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[ChannelN],hotcue_X_status` instead. + + + +.. mixxx:control:: [ChannelN],sync_master + [PreviewDeckN],sync_master + [SamplerN],sync_master + + Sets deck as leader clock. + + :range: binary + :feedback: If enabled, the :guilabel:`Sync` button stays lit and :term:`tempo` slider snap to the appropriate value. Slider adjustments are linked on all decks that have :term:`sync lock` enabled. + + .. versionadded:: 2.0.0 + .. versionchanged:: 2.3.0 + This button just enables :term:`sync lock` mode (similar to :mixxx:coref:`[ChannelN],sync_enabled`), it does not actually guarantee the deck will be the sync leader. This will be fixed in a future version. + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[ChannelN],sync_leader`, :mixxx:coref:`[PreviewDeckN],sync_leader` and :mixxx:coref:`[SamplerN],sync_leader` instead. + + +.. mixxx:control:: [ChannelN],beatloop + [PreviewDeckN],beatloop + [SamplerN],beatloop + + Setup a loop over the set number of beats. + + :range: positive real number + :feedback: A loop is shown over the set number of beats. + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[ChannelN],beatloop_size` and `[ChannelN],beatloop_toggle` instead. + + +.. mixxx:control:: [ChannelN],reloop_exit + [PreviewDeckN],reloop_exit + [SamplerN],reloop_exit + + 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. + + :range: binary + :feedback: Loop range in waveform activates or deactivates. + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[ChannelN],reloop_toggle` instead. + + +.. mixxx:control:: [ChannelN],jog + [PreviewDeckN],jog + [SamplerN],jog + + Affects relative playback speed and direction for short instances (additive & is automatically reset to 0). + + :range: -3.0..3.0 + :feedback: waveform + + .. deprecated:: ?? + Use the JavaScript ``engine.scratch`` functions instead. + + +.. mixxx:control:: [ChannelN],scratch + [PreviewDeckN],scratch + [SamplerN],scratch + + Affects playback speed and direction ([differently whether currently playing or not](https://github.com/mixxxdj/mixxx/issues/5350)) (multiplicative). + + :range: -3.0..3.0 + :feedback: Waveform + + .. deprecated:: ?? + Use the JavaScript ``engine.scratch`` functions instead. + + +.. mixxx:control:: [ChannelN],filter + [PreviewDeckN],filter + [SamplerN],filter + + Toggles the filter effect. + + :range: binary + :feedback: Filter button + + .. versionadded:: 2.0.0 + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]_Effect1],enabled <[QuickEffectRack1_[ChannelI]_Effect1],enabled>` instead. + + +.. mixxx:control:: [ChannelN],filterDepth + [PreviewDeckN],filterDepth + [SamplerN],filterDepth + + Adjusts the intensity of the filter effect. + + :range: default + :feedback: Filter depth knob + + .. versionadded:: 2.0.0 + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]],super1 <[QuickEffectRack1_[ChannelI]],super1>` instead. + + +.. mixxx:control:: [ChannelN],filterLow + [PreviewDeckN],filterLow + [SamplerN],filterLow + + Adjusts the gain of the low :term:`EQ` filter. + + :range: 0.0..1.0..4.0 + :feedback: Low EQ knob + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelN]_Effect1],parameter1 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. + + +.. mixxx:control:: [ChannelN],filterLowKill + [PreviewDeckN],filterLowKill + [SamplerN],filterLowKill + + Holds the gain of the low :term:`EQ` to -inf while active + + :range: binary + :feedback: Low EQ :term:`kill switch` + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter1 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. + + +.. mixxx:control:: [ChannelN],filterMid + [PreviewDeckN],filterMid + [SamplerN],filterMid + + Adjusts the gain of the mid :term:`EQ` filter.. + + :range: 0.0..1.0..4.0 + :feedback: Mid EQ knob + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],parameter2 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. + + +.. mixxx:control:: [ChannelN],filterMidKill + [PreviewDeckN],filterMidKill + [SamplerN],filterMidKill + + Holds the gain of the mid :term:`EQ` to -inf while active. + + :range: binary + :feedback: Mid EQ :term:`kill switch` + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter2 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. + + +.. mixxx:control:: [ChannelN],filterHigh + [PreviewDeckN],filterHigh + [SamplerN],filterHigh + + Adjusts the gain of the high :term:`EQ` filter. + + :range: 0.0..1.0..4.0 + :feedback: High EQ knob + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],parameter3 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. + + +.. mixxx:control:: [ChannelN],filterHighKill + [PreviewDeckN],filterHighKill + [SamplerN],filterHighKill + + Holds the gain of the high :term:`EQ` to -inf while active. + + :range: binary + :feedback: High EQ :term:`kill switch` + + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter3 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. + + +.. mixxx:control:: [ChannelN],beatloop_X + [PreviewDeckN],beatloop_X + [SamplerN],beatloop_X + + Setup a loop over X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64 + + :range: toggle + :feedback: A loop is shown over X beats. + + .. versionadded:: 1.10.0 + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[ChannelN],beatloop_X_activate` instead. + + +.. mixxx:control:: [MicrophoneN],enabled + [AuxiliaryN],enabled + + 1 if a channel input is enabled, 0 if not. + + :range: binary + :feedback: Microphone is enabled. + + .. versionadded:: 1.10.0 + .. deprecated:: 2.0.0 + Use :mixxx:coref:`[MicrophoneN],input_configured` instead. + + +.. mixxx:control:: [MicrophoneN],master + [AuxiliaryN],master + + Hold value at 1 to mix channel input into the main output. + For :mixxx:cogroupref:`[MicrophoneN]` use :mixxx:coref:`[MicrophoneN],talkover` instead. + Note that :mixxx:cogroupref:`[AuxiliaryN]` also take :mixxx:coref:`[AuxiliaryN],orientation` into account. + + :range: binary + :feedback: Auxiliary: Play button + Microphone: N/A + + .. deprecated:: 2.4.0 + Use :mixxx:coref:`[MicrophoneN],talkover` and :mixxx:coref:`[AuxiliaryN],main_mix` instead. + + +.. mixxx:control:: [MicrophoneN],orientation + + .. versionadded:: 1.10.0 + .. deprecated:: 1.10.0 + + The control is not processed in the Mixer, which is also why there are no orientation controls for Microphones in the GUI. + + +.. mixxx:control:: [Playlist],LoadSelectedIntoFirstStopped + :range: binary + :feedback: Waveform view + + Loads the currently highlighted song into the first stopped deck + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],GoToItem` instead. + + +.. mixxx:control:: [Playlist],SelectNextPlaylist + :range: binary + :feedback: Library sidebar + + Switches to the next view (Library, Queue, etc.) + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],MoveDown` instead. + + +.. mixxx:control:: [Playlist],SelectPrevPlaylist + + :range: binary + :feedback: Library sidebar + + Switches to the previous view (Library, Queue, etc.) + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],MoveUp` instead. + + +.. mixxx:control:: [Playlist],ToggleSelectedSidebarItem + :range: binary + :feedback: Library sidebar + + Toggles (expands/collapses) the currently selected sidebar item. + + .. versionadded:: 1.11.0 + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],GoToItem` instead. + + +.. mixxx:control:: [Playlist],SelectNextTrack + :range: binary + :feedback: Library track table highlight + + Scrolls to the next track in the track table. + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],MoveDown` instead. + + +.. mixxx:control:: [Playlist],SelectPrevTrack + :range: binary + :feedback: Library track table highlight + + Scrolls to the previous track in the track table. + + .. deprecated:: 2.1.0 + Use :mixxx:coref:`[Library],MoveUp` instead. + + Removed controls ~~~~~~~~~~~~~~~~