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

Help: [skip ci] Using MIDI guide: Explain MIDIFunc/MIDIdef filtering #5136

Merged
merged 2 commits into from
Aug 17, 2020

Conversation

jamshark70
Copy link
Contributor

Purpose and Motivation

MIDIFunc help for srcID directs the user to the MIDIClient help file, which... doesn't explain MIDIEndPoints or UIDs at all.

Just had a thread on the user forum where it was not clear how to use this parameter.

Types of changes

  • Documentation

To-do list

  • Updated documentation
  • This PR is ready for review

@jamshark70 jamshark70 added the comp: help schelp documentation label Aug 13, 2020

MIDIFunc and MIDIdef can filter incoming messages, responding to specific devices, MIDI channels or data values. For example, you may want one MIDIFunc to handle controller 1, while a different MIDIFunc handles controller 7.

Filters are set by the argument immediately following the response function: code::MIDIFunc.incomingType({ ... function ... }, msgNum, chan, srcID):: where the meaning of msgNum depends on the message type.
Copy link
Contributor

Choose a reason for hiding this comment

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

consider changing ... function ... to /* function */. the first could lead to misunderstandings about whether what's inside the braces is meant literally or not. i just saw this the other day on a C++ forum, about almost exactly the same ambiguity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea -- done.

Copy link
Contributor

@mossheim mossheim left a comment

Choose a reason for hiding this comment

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

lgtm, thanks!

@mossheim mossheim merged commit b2b0fd2 into supercollider:develop Aug 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: help schelp documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants