Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add aliased controls and move deprecated COs in separate section #579

Merged
merged 6 commits into from
Dec 29, 2023
Merged

Add aliased controls and move deprecated COs in separate section #579

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0f8d706
appendix/mixxx_controls: Document `[App]` group and add missing controls
Holzhaus Sep 17, 2023
09e8abb
appendix/mixxx_controls: Move `samplerate` into `[App]` group
Holzhaus Sep 17, 2023
933ad9d
appendix/mixxx_controls: Move all deprecated COs into separate section
Holzhaus Sep 17, 2023
f84c9e7
appendix/mixxx_controls: Fix broken `versionadded` directive
Holzhaus Sep 21, 2023
f84d9a3
appendix/mixxx_controls: Add `[Skin]` section
Holzhaus Sep 21, 2023
1c33f49
appendix/mixxx_controls: Document which new controls are a replacement
Holzhaus Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 109 additions & 47 deletions source/chapters/appendix/mixxx_controls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,92 @@ 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 <interface-cue-modes>`).

: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 <interface-cue-modes>`).

: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


.. mixxx:control:: [App],num_samplers

The number of samplers currently enabled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this value change when switching the skin? I think a mapping developer needs to know, if it's constant over the runtime of the mapping.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's constant, but I don't really know. I did not change the current description, just moved it into a new [App] section. If you have a new wording please make a suggestion and I'll include it. Otherwise this could be improved in a later PR (maybe file an issue).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC the CO is adjusted to the maximum of

  • num_samplers set in skin manifest
  • samplers.xml loaded at startup
  • any other sampler bank XML loaded manually later on


:range: integer
:feedback: None

.. versionadded:: 2.4.0


.. mixxx:control:: [App],num_preview_decks

The number of preview decks currently enabled.

:range: integer
:feedback: None

.. versionadded:: 2.4.0

.. mixxx:control:: [App],num_microphones

The number of microphone inputs that can be configured.

:range: integer
:feedback: None

.. versionadded:: 2.4.0


.. mixxx:control:: [App],num_auxiliaries

The number of auxiliary inputs that can be configured.

:range: integer
:feedback: None

.. versionadded:: 2.4.0



The ``[Master]`` group
~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -293,35 +379,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 <interface-cue-modes>`).

: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 <interface-cue-modes>`).

:range: binary, read-only
:feedback: None

.. versionadded:: 2.4.0

.. mixxx:control:: [Master],latency

Expand All @@ -343,12 +400,9 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:`

.. 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_effectsavailable
Expand All @@ -363,22 +417,30 @@ This will bear some similarity to what you will find on a DJ mixer (e.g. :term:`

.. mixxx:control:: [Master],num_samplers

The number of samplers currently enabled.
.. versionadded:: 1.9.0
.. deprecated:: 2.4.0
Use :mixxx:coref:`[App],num_samplers` instead.

:range: integer
:feedback: None

.. 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_preview_decks
.. mixxx:control:: [Master],num_microphones

The number of preview decks currently enabled.
.. versionadded:: 2.2.4
.. deprecated:: 2.4.0
Use :mixxx:coref:`[App],num_microphones` instead.

:range: integer
:feedback: None

.. versionadded:: 1.11.0
.. mixxx:control:: [Master],num_auxiliaries

.. versionadded:: 2.2.4
.. deprecated:: 2.4.0
Use :mixxx:coref:`[App],num_auxiliaries` instead.


.. mixxx:control:: [Master],PeakIndicator
Expand Down Expand Up @@ -881,7 +943,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
Expand All @@ -893,7 +955,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
Expand All @@ -905,7 +967,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
Expand Down Expand Up @@ -3923,8 +3985,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

Expand Down