Mercurial > hg > vamp-plugin-sdk

changeset 511:328cb056da44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc note
author Chris Cannam
date Fri, 11 May 2018 17:02:06 +0100
parents 8742125177ae
children 54277cb679ff
files vamp-hostsdk/PluginLoader.h
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/vamp-hostsdk/PluginLoader.h	Thu Feb 08 15:40:33 2018 +0000
+++ b/vamp-hostsdk/PluginLoader.h	Fri May 11 17:02:06 2018 +0100
@@ -233,6 +233,12 @@
      * Given a Vamp plugin library name and plugin identifier, return
      * the corresponding plugin key in a form suitable for passing in to
      * loadPlugin().
+     *
+     * (Note that the reverse of this is not well-defined and is not
+     * offered in this API - consider using getLibraryPathForPlugin
+     * instead. See documentation for the PluginKey type for details.)
+     *
+     * \see PluginKey, getLibraryPathForPlugin, loadPlugin
      */
     PluginKey composePluginKey(std::string libraryName,
                                std::string identifier);