diff --git a/source/hardware/controllers/native_instruments_traktor_kontrol_s4_mk3.rst b/source/hardware/controllers/native_instruments_traktor_kontrol_s4_mk3.rst index c1cfe59752..faea71a761 100644 --- a/source/hardware/controllers/native_instruments_traktor_kontrol_s4_mk3.rst +++ b/source/hardware/controllers/native_instruments_traktor_kontrol_s4_mk3.rst @@ -9,8 +9,7 @@ The S4 MK3 uses the standard :term:`HID` protocol for the Buttons, Knobs, Faders The screens use a USB Bulk transfer. Mixxx doesn't support rendering content for external screens yet. The easiest way to tell the MK3 apart from the other MK1 and 2 are these screens, displace between the "Move" and "Loop" encoder. -The Kontrol S4 Mk3 can run from :term:`USB` power. -Using the separate power supply increases the brightness of the LEDs, which is helpful for using it in daylight, and increases the volume of the headphone output. +Unlike its predecessor, the Kontrol S4 Mk3 cannot run from :term:`USB` power and the separate power supply must be used. - `Manufacturer’s product page `__ @@ -30,9 +29,17 @@ Controller Setup audio output ~~~~~~~~~~~~~~~~~~ -In order to use the audio output of the controller, `Channels 1 - 2` should be set as `Main` and `Channels 3 - 4` should be set as `Headphones` +Using the S4 mixer +^^^^^^^^^^^^^^^^^^ - .. note:: The master and headphone knobs aren't mapped to Mixxx but instead control the the hardware directly. If you don't use the controller outputs, these knobs won't have any effect. +In order to use the audio output of the controller, select the device :guilabel:`Traktor Kontrol S4 MK3`. :guilabel:`Channels 1 - 2` should be set as :guilabel:`Main` and :guilabel:`Channels 3 - 4` should be set as :guilabel:`Headphones` + +Using the software mixer +^^^^^^^^^^^^^^^^^^^^^^^^ + +If you don't want to use certain outputs of the device, you can enable the mapping of the mixer knob to the Mixxx internal mixer. Head over to the :ref:`settings` to enable these optional mappings. + + .. note:: The mixer knobs are physically linked to the S4 embedded mixer. This means that there is no way to prevent these buttons to adjust gains of the output, and will lead to unexpected volume mixing if the Mixxx mixer is used while also using S4 outputs. Known bugs and limitation @@ -84,37 +91,37 @@ Jogwheel can be used to control various things, depending of the mode they are i Here is how to tell what mode is on, depending the current state of the LED: -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ -| Mode | Jog | TT | Jogwheel | Others | -+================+==========+=========+================================================+=========================================+ -| Vinyl mode | On | Off | Circling while the track is playing/scratching | -- | -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ -| Jog mode | Off | Off | Circling while the track is playing/scratching | -- | -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ -| Turntable mode | Off | On | Circling while the track is playing/scratching | -- | -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ -| Loop in | -- | -- | The whole circle is blinking | The :hwlabel:`REV` button is blinking | -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ -| Loop out | -- | -- | The whole circle is blinking | The :hwlabel:`FLX` button is blinking | -+----------------+----------+---------+------------------------------------------------+-----------------------------------------+ ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ +| Mode | :hwlabel:`Jog` | :hwlabel:`TT` | Jogwheel | Others | ++================+================+===============+================================================+=========================================+ +| Vinyl mode | On | Off | Circling while the track is playing/scratching | -- | ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ +| Jog mode | Off | Off | Circling while the track is playing/scratching | -- | ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ +| Turntable mode | Off | On | Circling while the track is playing/scratching | -- | ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ +| Loop in | -- | -- | The whole circle is blinking | The :hwlabel:`REV` button is blinking | ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ +| Loop out | -- | -- | The whole circle is blinking | The :hwlabel:`FLX` button is blinking | ++----------------+----------------+---------------+------------------------------------------------+-----------------------------------------+ Here is how to select each mode: -+----------------+---------------------------------------------------------------------------+ -| Mode | | -+================+===========================================================================+ -| Vinyl mode | Press the "Jog" button (while the "Jog" button is off) | -+----------------+---------------------------------------------------------------------------+ -| Jog mode | Press the "Jog" button while in vinyl mode (while the "Jog" button is on) | -+----------------+---------------------------------------------------------------------------+ -| Turntable mode | Press the "TT" button. Pressing again while restore the Vinyl mode | -+----------------+---------------------------------------------------------------------------+ -| Loop in | Press :hwlabel:`SHIFT` + :hwlabel:`REV` while a loop is enable | -+----------------+---------------------------------------------------------------------------+ -| Loop out | Press :hwlabel:`SHIFT` + :hwlabel:`FLX` while a loop is enable | -+----------------+---------------------------------------------------------------------------+ ++----------------+---------------------------------------------------------------------------------------------+ +| Mode | | ++================+=============================================================================================+ +| Vinyl mode | Press the :hwlabel:`Jog` button (while the :hwlabel:`Jog` button is off) | ++----------------+---------------------------------------------------------------------------------------------+ +| Jog mode | Press the :hwlabel:`Jog` button while in vinyl mode (while the :hwlabel:`Jog` button is on) | ++----------------+---------------------------------------------------------------------------------------------+ +| Turntable mode | Press the :hwlabel:`TT` button. Pressing again while restore the Vinyl mode | ++----------------+---------------------------------------------------------------------------------------------+ +| Loop in | Press :hwlabel:`SHIFT` + :hwlabel:`REV` while a loop is enable | ++----------------+---------------------------------------------------------------------------------------------+ +| Loop out | Press :hwlabel:`SHIFT` + :hwlabel:`FLX` while a loop is enable | ++----------------+---------------------------------------------------------------------------------------------+ -For all modes but "Vinyl" and "Jog", re-selecting the mode will restore the previous one. +For all modes but :hwlabel:`Vinyl` and :hwlabel:`Jog`, re-selecting the mode will restore the previous one. Move modes @@ -271,7 +278,7 @@ All mapping detail | | - While in beatloop roll mode: | | | | | | | | - Will activate a beatloop roll of 1/16, 1/8, 1/4 , 1/2, 1, | | -| | 2, 4 and 8 beats, or custom size if you have change | | +| | 2, 4 and 8 beats, or custom size if you have changed | | | | `BeatLoopRolls` in :ref:`settings` | | +------------------+------------------------------------------------------------------+------------------------------------------+ | FX 1st knob | - Master volume/mix of the unit | | @@ -345,6 +352,14 @@ All mapping detail +------------------+------------------------------------------------------------------+------------------------------------------+ | Ext | Apply the current gain as default. This will reset the gain knob.| | +------------------+------------------------------------------------------------------+------------------------------------------+ +| Master | If enabled in the :ref:`settings`, change the main gain | | ++------------------+------------------------------------------------------------------+------------------------------------------+ +| Booth | If enabled in the :ref:`settings`, change the booth gain | | ++------------------+------------------------------------------------------------------+------------------------------------------+ +| Cue | If enabled in the :ref:`settings`, adjust the headphone mix | | ++------------------+------------------------------------------------------------------+------------------------------------------+ +| Headphone volume | If using Mixxx internal mixer, change the headphone gain | | ++------------------+------------------------------------------------------------------+------------------------------------------+ Looping @@ -369,9 +384,9 @@ Mapping options There are various option that can be used to change some behavior: -============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ==================================================================================================================================================================================== +============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ================================================================================================================================================================================================================ Setting Variable value Default Range Description -============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ==================================================================================================================================================================================== +============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ================================================================================================================================================================================================================ Deck colors `DeckColors` LEDColors.red,LEDColors.blue,LEDColors.yellow, LEDColors.purple **All colors as defined in _LedColors_. Must be four color, separated by a comma** Define the leading colors for each decks. Note that some buttons have only one color Sortable column in the library `LibrarySortableColumns` LibraryColumns.Artist, LibraryColumns.Title, LibraryColumns.BPM, LibraryColumns.Key, LibraryColumns.DatetimeAdded **All values defined in** `the Mixxx control documentation`_ **separated by a comma** Define the list of columns on which it possible to sort the library using the library encoder and the view button Loop In/Out jogwheel sensitivity `LoopWheelMoveFactor` 50 -500..500 (Recommended) Define the sensitivity when moving the loop start or end point using the loop jogwheel mode. Negative value will reverse the order @@ -382,7 +397,7 @@ Color of the tempo led when on high takeover Keep transport and play button dimmed when off `InactiveLightsAlwaysBacklit` true true/false Having this setting on will keep LED always dimmed, even when off, although they may not have a matching color with the deck's color Keep the unselected deck button off rather than show its deck color `DeckSelectAlwaysBacklit` true true/false Having this setting on will keep the LED of the unselected deck dimmed instead of off. Keylock on :hwlabel:`SHIFT` + :hwlabel:`MASTER` instead of :hwlabel:`SHIFT` + :hwlabel:`SYNC` `UseKeylockOnMaster` false true/false Use :hwlabel:`SHIFT` + :hwlabel:`MASTER` to toggle the keylock instead of :hwlabel:`SHIFT` + :hwlabel:`SYNC` -Make the grid button blink when over a detected beat `GridButtonBlinkOverBeat` false true/false Make the :hwlabel:`GRID` button blinking when the playback goes over a detected beat +Make the :hwlabel:`grid` button blink when over a detected beat `GridButtonBlinkOverBeat` false true/false Make the :hwlabel:`GRID` button blinking when the playback goes over a detected beat Make the jogwheel ring blink when the track playing is near the end `WheelLedBlinkOnTrackEnd` true true/false The jogwheel LED ring will start blinking when a track is near the end. The end section can be defined in :menuselection:`Preferences --> Waveforms --> End of track warning` Use the mixer to control input when using :hwlabel:`SHIFT` `MixerControlsMixAuxOnShift` false true/false Make the :hwlabel:`GRID` button blinking when the playback goes over a detected beat Number of samples used for jogwheel speed `WheelSpeedSample` 3 1..50 Number of samples used to determine the jogwheel movement. A higher value will increase precision but latency too, and vice-versa @@ -391,7 +406,11 @@ Define the predefined size to use for the beatloop tab Use the two last tab as loop half/double buttons in the beatloop tab `AddLoopHalveAndDoubleOnBeatloopRollTab` true true/false Use the last two pad from the bottom row as loop half and loop double. These can be used to interact with beatloop roll and normal loop. Jogwheel speed (in turntable mode, as well as LED indicator) `BaseRevolutionsPerMinute` 33 + 1/3 33+1/3, 45 (Recommended) The turntable mode defines how fast the jogwheel turns (if on) as well as the LED, and the overall jogwheel sensitivity. It is recommended to keep either 33 + 1/3 or 45 as a value Whether or not to use haptic feedback features `UseMotors` false true/false Whether or not to use haptic feedback features. This is a beta feature, some of them may be unstable. -============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ==================================================================================================================================================================================== +Map the mixer :hwlabel`Master` knob to the Mixxx internal mixer `SoftwareMixerMain` false true/false When enabled, the Master knob will drive the Main gain of the Mixxx internal mixer as well as the hardware built-in mixer in the device. +Map the mixer :hwlabel`Booth` knob to the Mixxx internal mixer `SoftwareMixerBooth` false true/false When enabled, the Booth knob will drive the Booth gain of the Mixxx internal mixer as well as the hardware built-in mixer in the device. +Map the mixer headphone knobs :hwlabel`VOL` and :hwlabel`MIX` to the Mixxx internal mixer `SoftwareMixerHeadphone` false true/false When enabled, the headphone knobs will drive the headphone controls of the Mixxx internal mixer as well as the hardware built-in mixer in the device. +Default Pad Layout `DefaultPadLayout` default default,hotcue,samplerBeatloop,keyboard Define the default layout used for the pads. +============================================================================================== =========================================== ================================================================================================================= ===================================================================================== ================================================================================================================================================================================================================ .. _the Mixxx control documentation: https://manual.mixxx.org/latest/en/chapters/appendix/mixxx_controls.html#control-[Library]-sort_column @@ -425,4 +444,4 @@ For now you’ll have to make a small change to the mapping script file. Don’t Mixxx 2.5+ ^^^^^^^^^^ -Settings can be edited in the preference windows, under :guilabel:`Preferences` > :guilabel:`Controllers` > :guilabel:`YourController`. +Settings can be edited in the preference windows, under :guilabel:`Preferences` > :guilabel:`Controllers` > :guilabel:`Traktor Kontrol S4 MK3 ...`.