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

fix beatjump description and beatsize range #611

Merged
merged 4 commits into from
Feb 17, 2024
Merged

fix beatjump description and beatsize range #611

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
720f5c0
fix beatsize range (upper limit is 512)
ronso0 Feb 5, 2024
b6aee3f
fix beatjump description
ronso0 Feb 5, 2024
fc01651
controls: add missing linebreaks before :range:
ronso0 Feb 16, 2024
e231c19
controls: add missing beatjump/loopsizes, add some line breaks
ronso0 Feb 17, 2024
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
52 changes: 36 additions & 16 deletions source/chapters/appendix/mixxx_controls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp


Its value is set to the sample position of the closest beat of the active beat and is used for updating the beat LEDs.

:range: -1, 0.0, real-valued
:feedback: None

Expand All @@ -502,6 +503,7 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[SamplerN],beat_distance

Outputs the relative position of the play marker in the section between the the previous and next beat marker.

:range: 0.0 - 1.0, real-valued
:feedback: None

Expand All @@ -510,9 +512,9 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump
[SamplerN],beatjump

Jump forward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>` (positive) or backward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>` (negative). If a loop is active, the loop is moved by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`.
Jump forward (positive) or backward (negative) by N beats. If a loop is active, the loop is moved by X beats.
Copy link
Member

Choose a reason for hiding this comment

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

Might make sense to split these long lines and put each sentence on a separate lines if you touch them anyway. Your decision.

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'm not sure whether the line breaks would really be helpful here. If applied consistently for all controls, the page would grow enormously when being viewed on mobile screens.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I meant regular line break to make diff nicer to read. I thought this was not make da difference in the resulting html unless you put a blank line in between. Is that incorrect?

Copy link
Member Author

Choose a reason for hiding this comment

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

Haha, okay, sure.


:range: real number, -1, 0, 1
:range: any real number within the range, see :mixxx:coref:`[ChannelN],beatloop_X_activate`
:feedback: Player jumps forward or backward by X beats.

.. versionadded:: 2.0.0
Expand All @@ -522,7 +524,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump_size
[SamplerN],beatjump_size

Set the number of beats to jump with :mixxx:coref:`beatjump_forward <[ChannelN],beatjump_forward>`/:mixxx:coref:`beatjump_backward <[ChannelN],beatjump_backward>`.
Set the number of beats to jump with :mixxx:coref:`beatjump_forward <[ChannelN],beatjump_forward>`
/:mixxx:coref:`beatjump_backward <[ChannelN],beatjump_backward>`.

:range: positive real number
:feedback: Beatjump size spinbox
Expand All @@ -534,7 +537,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump_forward
[SamplerN],beatjump_forward

Jump forward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`. If a loop is active, the loop is moved forward by X beats.
Jump forward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`.
If a loop is active, the loop is moved forward by X beats.

:range: binary
:feedback: Player jumps forward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`.
Expand All @@ -546,7 +550,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump_backward
[SamplerN],beatjump_backward

Jump backward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`. If a loop is active, the loop is moved backward by X beats.
Jump backward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`.
If a loop is active, the loop is moved backward by X beats.

:range: binary
:feedback: Player jumps backward by :mixxx:coref:`beatjump_size <[ChannelN],beatjump_size>`.
Expand All @@ -558,7 +563,9 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump_X_forward
[SamplerN],beatjump_X_forward

Jump forward by X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64. If a loop is active, the loop is moved forward by X betas.
Jump forward by X beats. A control exists for
X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512.
If a loop is active, the loop is moved forward by X beats.

:range: binary
:feedback: Player jumps forward by X beats.
Expand All @@ -570,7 +577,9 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatjump_X_backward
[SamplerN],beatjump_X_backward

Jump backward by X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64. If a loop is active, the loop is moved backward by X beats.
Jump backward by X beats. A control exists for
X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512.
If a loop is active, the loop is moved backward by X beats.

:range: binary
:feedback: Player jumps backward by X beats.
Expand All @@ -594,7 +603,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatloop_X_activate
[SamplerN],beatloop_X_activate

Activates 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
Activates 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, 128, 256, 512

:range: binary
:feedback: A loop is shown over X beats.
Expand All @@ -606,8 +616,11 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatloop_size
[SamplerN],beatloop_size

Set the length of the loop in beats that will get set with :mixxx:coref:`beatloop_activate <[ChannelN],beatloop_activate>` and :mixxx:coref:`beatlooproll_activate <[ChannelN],beatlooproll_activate>`.
Changing this will resize an existing loop if the length of the loop matches :mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>`.
Set the length of the loop in beats that will get set with
:mixxx:coref:`beatloop_activate <[ChannelN],beatloop_activate>` and
:mixxx:coref:`beatlooproll_activate <[ChannelN],beatlooproll_activate>`.
Changing this will resize an existing loop if the length of the loop matches
:mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>`.

:range: positive real number
:feedback: Beatloop size spinbox and possibly loop section on waveform
Expand All @@ -619,7 +632,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatloop_X_toggle
[SamplerN],beatloop_X_toggle

Toggles 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
Toggles 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, 128, 256, 512

:range: binary
:feedback: A loop is shown over X beats.
Expand All @@ -643,7 +657,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatlooproll_activate
[SamplerN],beatlooproll_activate

Activates a rolling loop over :mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>` beats. Once disabled, playback will resume where the track would have been if it had not entered the loop.
Activates a rolling loop over :mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>` beats.
Once disabled, playback will resume where the track would have been if it had not entered the loop.

:range: binary
:feedback: A loop overlay is shown over :mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>` beats on waveform.
Expand All @@ -655,7 +670,9 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],beatlooproll_X_activate
[SamplerN],beatlooproll_X_activate

Activates a rolling loop over X beats. Once disabled, playback will resume where the track would have been if it had not entered the loop. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64
Activates a rolling loop over X beats. Once disabled, playback will resume where the
track would have been if it had not entered the loop. A control exists for
X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512

:range: binary
:feedback: Beatloop X button in skin is lit. A loop overlay is shown over X beats on waveform.
Expand Down Expand Up @@ -1516,7 +1533,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],loop_move_X_forward
[SamplerN],loop_move_X_forward

Moves the loop in and out points forward by X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64
Moves the loop in and out points forward by X beats. A control exists for
X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512

:range: binary
:feedback: Loop moves forward by X beats.
Expand All @@ -1528,7 +1546,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],loop_move_X_backward
[SamplerN],loop_move_X_backward

Loop moves by X beats. A control exists for X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64
Loop moves by X beats. A control exists for
X = 0.03125, 0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512

:range: binary
:feedback: Loop moves backward by X beats.
Expand All @@ -1540,7 +1559,8 @@ Any control listed above for :mixxx:cogroupref:`[ChannelN]` will work for a samp
[PreviewDeckN],loop_scale
[SamplerN],loop_scale

Scale the loop length by the value scale is set to by moving the end marker. :mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>` is not updated to reflect the change.
Scale the loop length by the value scale is set to by moving the end marker.
:mixxx:coref:`beatloop_size <[ChannelN],beatloop_size>` is not updated to reflect the change.

:range: 0.0 - infinity
:feedback: Loop length is scaled by given amount on waveform.
Expand Down
Loading