Document missing Mixxx Controls

[Holzhaus]

A lot of controls displayed in Mixxx' developer tools are not documented:

• [ ] [Master],boothDelay
• [ ] [Master],delay
• [ ] [Master],headDelay
• [ ] [Master],microphoneLatencyCompensation
• [x] [AuxiliaryN],orientation_center
• [x] [AuxiliaryN],orientation_left
• [x] [AuxiliaryN],orientation_right
• [x] [AuxiliaryN],talkover
• [x] [ChannelN],beat_closest
• [x] [ChannelN],beat_distance
• [ ] [ChannelN],beat_next
• [ ] [ChannelN],beat_prev
• [x] [ChannelN],cue_clear
• [x] [ChannelN],cue_goto
• [x] [ChannelN],cue_mode
• [ ] [ChannelN],filterHighKill_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],button_parameter3_loaded
• [ ] [ChannelN],filterHigh_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],parameter3_loaded
• [ ] [ChannelN],filterLow_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],parameter1_loaded
• [ ] [ChannelN],filterLowKill_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],button_parameter1_loaded
• [ ] [ChannelN],filterMidKill_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],button_parameter2_loaded
• [ ] [ChannelN],filterMid_loaded - Alias for [EqualizerRack1_[ChannelN]_Effect1],parameter2_loaded
• [ ] [ChannelN],filterWaveformEnable
• [ ] [ChannelN],hotcue_X_activate_preview
• [ ] [ChannelN],keylockMode
• [ ] [ChannelN],keyunlockMode
• [x] [ChannelN],local_bpm
• [ ] [ChannelN],master
• [x] [ChannelN],orientation_center
• [x] [ChannelN],orientation_left
• [x] [ChannelN],orientation_right
• [ ] [ChannelN],replaygain
• [ ] [ChannelN],scratch2_indicates_scratching
• [ ] [ChannelN],scratch_position
• [ ] [ChannelN],scratch_position_enable
• [ ] [ChannelN],shift_cues
• [ ] [ChannelN],shift_cues_earlier
• [ ] [ChannelN],shift_cues_earlier_small
• [ ] [ChannelN],shift_cues_later
• [ ] [ChannelN],shift_cues_later_small
• [ ] [ChannelN],talkover
• [ ] [ChannelN],time_elapsed
• [ ] [ChannelN],time_remaining
• [ ] [ChannelN],total_gain
• [ ] [ChannelN],vinylcontrol_rate
• [ ] [ChannelN],vinylcontrol_scratching
• [ ] [ChannelN],vinylcontrol_seek
• [ ] [ChannelN],vinylcontrol_signal_enabled
• [ ] [ChannelN],vinylcontrol_speed_type
• [ ] [ChannelN],vinylcontrol_wantenabled
• [x] [Controls],ShowDurationRemaining
• [ ] [Controls],TimeFormat
• [ ] [EffectRack1_EffectUnitN],group_[AuxiliaryK]_enable
• [ ] [EffectRack1_EffectUnitN],group_[BusCenter]_enable
• [ ] [EffectRack1_EffectUnitN],group_[BusLeft]_enable
• [ ] [EffectRack1_EffectUnitN],group_[BusRight]_enable
• [ ] [EffectRack1_EffectUnitN],group_[BusTalkover]_enable
• [ ] [EffectRack1_EffectUnitN],group_[MasterOutput]_enable
• [ ] [EffectRack1_EffectUnitN],group_[MicrophoneK]_enable
• [ ] [EffectRack1_EffectUnitN],group_[PreviewDeckK]_enable
• [ ] [EffectRack1_EffectUnitN],mix_mode
• [ ] [ReplayGain],DefaultBoost
• [ ] [ReplayGain],ReplayGainBoost
• [ ] [ReplayGain],ReplayGainEnabled
• [x] [Shoutcast],enabled
• [x] [Shoutcast],status
• [ ] [SoundManager],status

[hannydevelop]

Hello @Holzhaus I know this would take some time to complete, can I work on it? Am sure I'll learn some new stuff! I could start working on it immediately I rebase #248 since I have implemented the designs already.

[Holzhaus]

Sure, feel free to open a PR. Also, you don't have to document all of them at once because it's probably a lot of work. Just start somewhere and open a PR. Someone else can take over the remaining COs or you come back to it later.

However, this will probably require to have a look at the C++ source code and check if there are any comments regarding the control objects (and try to understand what it does). I don't know if you have C++ knowledge, but looking at source code and trying to understand what it does can be a good way to get started. You can ask on the #development help channel on Zulip if you need help or have any questions.

[hannydevelop]

Sure @Holzhaus I will do that!

[som23ya]

@Holzhaus hey, can I work on these? :smile:

[Holzhaus]

@Holzhaus hey, can I work on these? :smile:

Sure. You don't need to ask for permission, just open a PR ;-)

[som23ya]

@Holzhaus Can you provide a reference for documentating the controls ? Like any previous mixxx controls which have been documented?

[Holzhaus]

@Holzhaus Can you provide a reference for documentating the controls ? Like any previous mixxx controls which have been documented?

https://manual.mixxx.org/2.3/en/chapters/advanced_topics.html#mixxx-controls

[som23ya]

@Holzhaus Hey, I have prepared the documentation for almost 10 controls. I wanted to know if I should add them to the 2.2 manual as the advanced topics in latest github code doesn't contain the developer tools. if not, then should I setup 2.3.x and how?

[Holzhaus]

we only document the controls in the manual for 2.3 and later. After cloning the git repo, branch off the 2.3 branch, not 2.2.