clap

commit bcdc1efc31edc27a5d8aabbae986bec8c7d2239d
parent a4706628275676f49ecdd00c639a10343760b49f
Author: Paul Walker <paul@pwjw.com>
Date:   Mon, 19 Feb 2024 10:25:36 -0500

Documentation: WildCards for PCK not allowed in note on

The NoteOn event needs port/channel/key specified. Add this
fact to the documentation.

Diffstat:
M
include/clap/events.h
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/include/clap/events.h b/include/clap/events.h
@@ -144,6 +144,12 @@ enum {
 // Well constructed plugins will search for voices and notes using
 // the entire tuple.
 //
+// In the case of note on events:
+// - The port, channel and key must be specified with a value >= 0
+// - A note-on event with a '-1' for Port Channel or Key is invalid and
+//   can be rejected or ignored by a plugin.
+// - A host which does not support note ids should set the note id to -1.
+//
 // In the case of note choke or end events:
 // - the velocity is ignored.
 // - key and channel are used to match active notes