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.

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

Document missing Mixxx Controls #261

Open
16 of 66 tasks
Holzhaus opened this issue Oct 29, 2020 · 9 comments
Open
16 of 66 tasks

Document missing Mixxx Controls #261

Holzhaus opened this issue Oct 29, 2020 · 9 comments

Comments

@Holzhaus
Copy link
Member

Holzhaus commented Oct 29, 2020

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

  • [Master],boothDelay
  • [Master],delay
  • [Master],headDelay
  • [Master],microphoneLatencyCompensation
  • [AuxiliaryN],orientation_center
  • [AuxiliaryN],orientation_left
  • [AuxiliaryN],orientation_right
  • [AuxiliaryN],talkover
  • [ChannelN],beat_closest
  • [ChannelN],beat_distance
  • [ChannelN],beat_next
  • [ChannelN],beat_prev
  • [ChannelN],cue_clear
  • [ChannelN],cue_goto
  • [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
  • [ChannelN],local_bpm
  • [ChannelN],master
  • [ChannelN],orientation_center
  • [ChannelN],orientation_left
  • [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
  • [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
  • [Shoutcast],enabled
  • [Shoutcast],status
  • [SoundManager],status
@hannydevelop
Copy link
Contributor

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
Copy link
Member Author

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
Copy link
Contributor

Sure @Holzhaus I will do that!

@som23ya
Copy link
Contributor

som23ya commented Jan 31, 2021

@Holzhaus hey, can I work on these? 😄

@Holzhaus
Copy link
Member Author

@Holzhaus hey, can I work on these? 😄

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

@som23ya
Copy link
Contributor

som23ya commented Feb 4, 2021

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

@Holzhaus
Copy link
Member Author

Holzhaus commented Feb 4, 2021

@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
Copy link
Contributor

som23ya commented Feb 7, 2021

@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
Copy link
Member Author

Holzhaus commented Feb 7, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants