clap

CLAP Audio Plugin API
Log | Files | Refs | README | LICENSE

commit 412ac9a78153bd1199489b96bbd6381ce242c00c
parent 8b7a76f4e441321c77d73a431bf4b66048696b8c
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date:   Thu, 10 Jun 2021 11:23:17 +0200

Complete the readme

Diffstat:
MREADME.md | 32+++++++++++++++++++++++++++++++-
1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md @@ -41,7 +41,7 @@ Some extensions are still in the progress of being designed and they are in the [draft](include/clap/ext/draft) folder. An extension comes with: -- an header +- an header `#include <clap/ext/xxx.h>` - an extension identifier: `#define CLAP_EXT_XXX "clap/XXX"` - host interfaces are named like: `stuct clap_host_xxx` - plugin interfaces are named like: `stuct clap_plugin_xxx` @@ -53,6 +53,36 @@ You can create your own extensions and share them, make sure that the extension **All strings are valid UTF-8**. +## Fundamental extensions + +This is a list of the extensions that you most likely want to implement +and use to get a basic plugin experience: +- [log](include/clap/ext/log.h), lets the host aggregate plugin logs +- [thread-check](include/clap/ext/thread-check.h), check which thread you are currently on, useful for correctness validation +- [audio-ports](include/clap/ext/audio-ports.h), define and configure the ports layout +- [params](include/clap/ext/params.h), parameters management +- [latency](include/clap/ext/latency.h), report the plugin latency +- [state](include/clap/ext/state.h), save and load the plugin state + +## GUI extensions + +- [gui](include/clap/ext/gui.h), generic gui controller +- [gui-win32](include/clap/ext/gui-win32.h), win32 specific +- [gui-cocoa](include/clap/ext/gui-cocoa.h), cocoa specific +- [gui-x11](include/clap/ext/gui-x11.h), x11 specific +- [event-loop](include/clap/ext/event-loop.h), mandatory on linux, let the plugin register IO event handlers and timer handlers + +## Extra extensions + +- [render](include/clap/ext/render.h), renders realtime or offline +- [note-name](include/clap/ext/draft/note-name.h), give a name to notes, useful for drum machines +- [tuning](include/clap/ext/draft/tuning.h), host provided microtuning +- [track-info](include/clap/ext/draft/track-info.h) +- [thread-pool](include/clap/ext/draft/thread-pool.h), use the host thread pool +- [quick-controls](include/clap/ext/draft/quick-controls.h), bank of controls that can be mapped on a controlles with 8 knobs +- [file-reference](include/clap/ext/draft/file-reference.h), let the host know about the plugin's file reference, and perform "Collect & Save" +- [check-for-update](include/clap/ext/draft/check-for-update.h), check if there is a new version of a plugin + ## Examples Visit the [examples](examples) folder.