From 933ad9d5433bc5ff4fbb6f6fb7edbe1f294ee8f5 Mon Sep 17 00:00:00 2001 From: Jan Holthuis Date: Sun, 17 Sep 2023 14:35:19 +0200 Subject: [PATCH] appendix/mixxx_controls: Move all deprecated COs into separate section --- source/chapters/appendix/mixxx_controls.rst | 922 ++++++++++---------- 1 file changed, 485 insertions(+), 437 deletions(-) diff --git a/source/chapters/appendix/mixxx_controls.rst b/source/chapters/appendix/mixxx_controls.rst index a8397cd855..dbb7b90a3b 100644 --- a/source/chapters/appendix/mixxx_controls.rst +++ b/source/chapters/appendix/mixxx_controls.rst @@ -408,13 +408,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],num_decks - - .. versionadded:: 1.9.0 - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],num_decks` instead. - - .. mixxx:control:: [Master],num_effectsavailable The number of available effects that can be selected in an effect slot. @@ -425,34 +418,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 - - .. versionadded:: 1.9.0 - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],num_samplers` instead. - - -.. mixxx:control:: [Master],num_preview_decks - - .. versionadded:: 1.9.0 - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],num_preview_decks` instead. - - -.. mixxx:control:: [Master],num_microphones - - .. versionadded:: 2.2.4 - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],num_microphones` instead. - - -.. mixxx:control:: [Master],num_auxiliaries - - .. versionadded:: 2.2.4 - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],num_auxiliaries` instead. - - .. mixxx:control:: [Master],PeakIndicator Indicates when the signal is clipping (too loud for the hardware and is being distorted) (composite). @@ -483,12 +448,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 - - .. deprecated:: 2.4.0 - Use :mixxx:coref:`[App],samplerate` instead. - - .. mixxx:control:: [Master],talkoverDucking Toggle microphone ducking mode (OFF, AUTO, MANUAL) @@ -529,27 +488,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 @@ -1293,28 +1231,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 @@ -2583,16 +2499,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 @@ -2900,337 +2806,134 @@ 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:: [Samplers],show_samplers - :range: positive real number - :feedback: A loop is shown over the set number of beats. + :range: binary + :feedback: Shows Sampler bank(s) - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[ChannelN],beatloop_size` and `[ChannelN],beatloop_toggle` instead. +.. mixxx:control:: [Sampler],SaveSamplerBank + Save sampler configuration. Make currently loaded tracks in samplers instantly available at a later point. -.. mixxx:control:: [ChannelN],reloop_exit - [PreviewDeckN],reloop_exit - [SamplerN],reloop_exit + :range: binary + :feedback: Opens file dialog. Configuration file can be named and saved. - 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. + .. versionadded: 2.0.0 - :range: binary - :feedback: Loop range in waveform activates or deactivates. - .. deprecated:: 2.1.0 - Use :mixxx:coref:`[ChannelN],reloop_toggle` instead. +.. mixxx:control:: [Sampler],LoadSamplerBank + Load saved sampler configuration file and add tracks to the available samplers. -.. mixxx:control:: [ChannelN],jog - [PreviewDeckN],jog - [SamplerN],jog + :range: binary + :feedback: Opens file dialog. Select configuration file. - Affects relative playback speed and direction for short instances (additive & is automatically reset to 0). + .. versionadded: 2.0.0 - :range: -3.0..3.0 - :feedback: waveform - .. deprecated:: ?? - Use the JavaScript ``engine.scratch`` functions instead. +.. _appendix-mixxxcontrols-aux: +Microphones and Auxiliary Channels +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. mixxx:control:: [ChannelN],scratch - [PreviewDeckN],scratch - [SamplerN],scratch +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). +Then you can use your :term:`MIDI` controller to control its volume and some other parameters (orientation, gain, :term:`volume`), apply effects and use the prelisten function. - Affects playback speed and direction ([differently whether currently playing or not](https://github.com/mixxxdj/mixxx/issues/5350)) (multiplicative). +.. 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]>`. - :range: -3.0..3.0 - :feedback: Waveform +.. mixxx:control:: [MicrophoneN],input_configured + [AuxiliaryN],input_configured - .. deprecated:: ?? - Use the JavaScript ``engine.scratch`` functions instead. + 1 if there is input is configured for this channel, 0 if not. + :range: binary, read-only + :feedback: Configured channel in the sound preferences. -.. mixxx:control:: [ChannelN],filter - [PreviewDeckN],filter - [SamplerN],filter - Toggles the filter effect. +.. mixxx:control:: [MicrophoneN],main_mix + [AuxiliaryN],main_mix - :range: binary - :feedback: Filter button + 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. - .. versionadded:: 2.0.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]_Effect1],enabled <[QuickEffectRack1_[ChannelI]_Effect1],enabled>` instead. + :range: binary + :feedback: Auxiliary: Play button + Microphone: N/A +.. mixxx:control:: [AuxiliaryN],orientation -.. mixxx:control:: [ChannelN],filterDepth - [PreviewDeckN],filterDepth - [SamplerN],filterDepth + Set channel orientation for the :term:`crossfader`. - Adjusts the intensity of the filter effect. + :range: + ===== =================================== + Value Meaning + ===== =================================== + 0 Left side of crossfader + 1 Center (not affected by crossfader) + 2 Right side of crossfader + ===== =================================== + :feedback: None - :range: default - :feedback: Filter depth knob + .. versionadded:: 1.10.0 - .. versionadded:: 2.0.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[QuickEffectRack1_[ChannelN]],super1 <[QuickEffectRack1_[ChannelI]],super1>` instead. +.. mixxx:control:: [MicrophoneN],PeakIndicator + [AuxiliaryN],PeakIndicator + Indicates when the signal is clipping (too loud for the hardware and is being distorted) -.. mixxx:control:: [ChannelN],filterLow - [PreviewDeckN],filterLow - [SamplerN],filterLow + This is a :ref:`ControlPotMeter control `. - Adjusts the gain of the low :term:`EQ` filter. + :range: binary + :feedback: Microphone Clip light - :range: 0.0..1.0..4.0 - :feedback: Low EQ knob + .. versionadded:: 1.10.0 - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelN]_Effect1],parameter1 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. +.. mixxx:control:: [MicrophoneN],PeakIndicatorL + [AuxiliaryN],PeakIndicatorL -.. mixxx:control:: [ChannelN],filterLowKill - [PreviewDeckN],filterLowKill - [SamplerN],filterLowKill + Indicates when the signal is clipping (too loud for the hardware and is being distorted) for the left channel - Holds the gain of the low :term:`EQ` to -inf while active + This is a :ref:`ControlPotMeter control `. - :range: binary - :feedback: Low EQ :term:`kill switch` + :range: binary + :feedback: Clip light (left) - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],button_parameter1 <[EqualizerRack1_[ChannelI]_Effect1],button_parameterK>` instead. + .. versionadded:: 2.0.0 +.. mixxx:control:: [MicrophoneN],PeakIndicatorR + [AuxiliaryN],PeakIndicatorR -.. mixxx:control:: [ChannelN],filterMid - [PreviewDeckN],filterMid - [SamplerN],filterMid - Adjusts the gain of the mid :term:`EQ` filter.. + Indicates when the signal is clipping (too loud for the hardware and is being distorted) for the right channel - :range: 0.0..1.0..4.0 - :feedback: Mid EQ knob + This is a :ref:`ControlPotMeter control `. - .. deprecated:: 2.0.0 - Use :mixxx:coref:`[EqualizerRack1_[ChannelI]_Effect1],parameter2 <[EqualizerRack1_[ChannelI]_Effect1],parameterK>` instead. + :range: binary + :feedback: Clip light (right) + .. versionadded:: 2.0.0 -.. mixxx:control:: [ChannelN],filterMidKill - [PreviewDeckN],filterMidKill - [SamplerN],filterMidKill +.. mixxx:control:: [MicrophoneN],pfl + [AuxiliaryN],pfl - Holds the gain of the mid :term:`EQ` to -inf while active. + Toggles :term:`headphone cueing (PFL) `. - :range: binary - :feedback: Mid EQ :term:`kill switch` + :range: binary + :feedback: Headphone button - .. 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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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). -Then you can use your :term:`MIDI` controller to control its volume and some other parameters (orientation, gain, :term:`volume`), apply effects and use the prelisten function. - -.. 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 - - 1 if there is input is configured for this channel, 0 if not. - - :range: binary, read-only - :feedback: Configured channel in the sound preferences. - - -.. mixxx:control:: [MicrophoneN],main_mix - [AuxiliaryN],main_mix - - 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 - -.. 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`. - - :range: - ===== =================================== - Value Meaning - ===== =================================== - 0 Left side of crossfader - 1 Center (not affected by crossfader) - 2 Right side of crossfader - ===== =================================== - :feedback: None - - .. 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 - - Indicates when the signal is clipping (too loud for the hardware and is being distorted) - - This is a :ref:`ControlPotMeter control `. - - :range: binary - :feedback: Microphone Clip light - - .. versionadded:: 1.10.0 - - -.. mixxx:control:: [MicrophoneN],PeakIndicatorL - [AuxiliaryN],PeakIndicatorL - - Indicates when the signal is clipping (too loud for the hardware and is being distorted) for the left channel - - This is a :ref:`ControlPotMeter control `. - - :range: binary - :feedback: Clip light (left) - - .. versionadded:: 2.0.0 - -.. mixxx:control:: [MicrophoneN],PeakIndicatorR - [AuxiliaryN],PeakIndicatorR - - - Indicates when the signal is clipping (too loud for the hardware and is being distorted) for the right channel - - This is a :ref:`ControlPotMeter control `. - - :range: binary - :feedback: Clip light (right) - - .. versionadded:: 2.0.0 - -.. mixxx:control:: [MicrophoneN],pfl - [AuxiliaryN],pfl - - Toggles :term:`headphone cueing (PFL) `. - - :range: binary - :feedback: Headphone button - - -.. mixxx:control:: [MicrophoneN],talkover - [AuxiliaryN],talkover +.. mixxx:control:: [MicrophoneN],talkover + [AuxiliaryN],talkover Hold value at 1 to mix channel input into the main output. For :mixxx:cogroupref:`[AuxiliaryN]` use :mixxx:coref:`[AuxiliaryN],main_mix` instead. @@ -3881,69 +3584,6 @@ 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 - - .. 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. - - - The ``[Controls]`` controls ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -4376,6 +4016,414 @@ Controls :range: integer, read-only +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:: [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 ~~~~~~~~~~~~~~~~