free-audio / clap

Audio Plugin API
https://cleveraudio.org/
MIT License
1.78k stars 100 forks source link

Outdated parameter documentation #282

Closed sadko4u closed 1 year ago

sadko4u commented 1 year ago

In params.h:

/// III. Turning a knob on the Plugin interface
/// - the plugin is responsible for sending the parameter value to its audio processor
/// - call clap_host_params->request_flush() or clap_host->request_process().
/// - when the host calls either clap_plugin->process() or clap_plugin_params->flush(),
///   send an automation event and don't forget to set begin_adjust,
///   end_adjust and should_record flags

But grep of the CLAP headers on words begin_adjust, end_adjust and should_record gives nothing. I think the documentation should be corrected here.

baconpaul commented 1 year ago

ooh yeah. that should be send a CLAP_EVENT_PARAM_GESTURE_BEGIN event and so on. nice catch.

abique commented 1 year ago

Thank you :+1: