commit 796619c02cc2063b08236a5ffd3cc6937cc4a231
parent a73640d8440d0346826ff738ef18aef9b0fbfb81
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date: Tue, 10 Jan 2023 18:19:04 +0100
doc.
Diffstat:
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/include/clap/ext/draft/preset-load.h b/include/clap/ext/draft/preset-load.h
@@ -11,9 +11,9 @@ extern "C" {
typedef struct clap_plugin_preset_load {
// Loads a preset in the plugin native preset file format from a URI. eg:
// - "file:///home/abique/.u-he/Diva/Presets/Diva/HS Bass Nine.h2p", load_key: null
- // - "plugin://<plugin-id>", load_key: <preset-id>
+ // - "plugin://<plugin-id>", load_key: <XXX>
//
- // The preset discovery provider defines the uri to be passed to this function.
+ // The preset discovery provider defines the uri and load_key to be passed to this function.
//
// [main-thread]
bool(CLAP_ABI *from_uri)(const clap_plugin_t *plugin, const char *uri, const char *load_key);
@@ -32,9 +32,11 @@ typedef struct clap_host_preset_load {
// Informs the host that the following preset has been loaded.
// This contributes to keep in sync the host preset browser and plugin preset browser.
+ // If the preset was loaded from a container file, then the subpath must be set, otherwise it
+ // must be null.
//
// [main-thread]
- void(CLAP_ABI *loaded)(const clap_host_t *host, const char *uri);
+ void(CLAP_ABI *loaded)(const clap_host_t *host, const char *uri, const char *subpath);
} clap_host_preset_load_t;
#ifdef __cplusplus
diff --git a/include/clap/factory/draft/preset-discovery.h b/include/clap/factory/draft/preset-discovery.h
@@ -99,7 +99,7 @@ typedef struct clap_preset_discovery_metadata_receiver {
// otherwise they must be null.
//
// The subpath defines a human friendly path to the preset in the container file.
- // It should be unique within the container file.
+ // It must be unique within the container file.
//
// The load_key is a machine friendly string used to load the preset inside the container via a
// the preset-load plug-in extension. The load_key can also just be the subpath if that's what the