clap

commit 301dd18df0f90398b3cba6a2db7755597e820924
parent 455a4788b8f2266073cceaabbfb41fc3486abee1
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Wed, 25 May 2022 16:58:20 +0200

Improve the NOTE_CHOKE documentation

Diffstat:
M
include/clap/events.h
 | 
7
+++++--

1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/include/clap/events.h b/include/clap/events.h
@@ -49,7 +49,11 @@ enum {
    // NOTE_ON and NOTE_OFF represents a key pressed and key released event.
    //
    // NOTE_CHOKE is meant to choke the voice(s), like in a drum machine when a closed hihat
-   // chokes an open hihat.
+   // chokes an open hihat. This event can be sent by the host to the plugin. Here two use case:
+   // - a plugin is inside a drum pad in Bitwig Studio's drum machine, and this pad is choked by
+   //   another one
+   // - the user double clicks the DAW's stop button in the transport which then stops the sound on
+   //   every tracks
    //
    // NOTE_END is sent by the plugin to the host. The port, channel, key and note_id are those given
    // by the host in the NOTE_ON event. In other words, this event is matched against the
@@ -109,7 +113,6 @@ enum {
 };
 typedef int32_t clap_event_type;
 
-
 // Note on, off, end and choke events.
 // In the case of note choke or end events:
 // - the velocity is ignored.