docs-v2/plugin_8hpp_source.html

#pragma once

#include <vector>


#include <common.hpp>

#include <plugin/Plugin.hpp>

#include <plugin/Model.hpp>


namespace rack {

namespace plugin {


PRIVATE void init();

PRIVATE void destroy();

PRIVATE void settingsMergeJson(json_t* rootJ);


Plugin* getPlugin(const std::string& pluginSlug);

Plugin* getPluginFallback(const std::string& pluginSlug);

Model* getModel(const std::string& pluginSlug, const std::string& modelSlug);

Model* getModelFallback(const std::string& pluginSlug, const std::string& modelSlug);


Model* modelFromJson(json_t* moduleJ);

bool isSlugValid(const std::string& slug);

std::string normalizeSlug(const std::string& slug);


extern std::string pluginsPath;

extern std::vector<Plugin*> plugins;


} // namespace plugin

} // namespace rack

Model.hpp

Plugin.hpp

common.hpp

PRIVATE
#define PRIVATE
Attribute for private functions not intended to be called by plugins.
Definition common.hpp:32

rack::asset::plugin
std::string plugin(plugin::Plugin *plugin, std::string filename="")
Returns the path of an asset in the plugin's dir.

rack::plugin::getModel
Model * getModel(const std::string &pluginSlug, const std::string &modelSlug)
Finds a loaded Model by plugin and model slug.

rack::plugin::plugins
std::vector< Plugin * > plugins

rack::plugin::normalizeSlug
std::string normalizeSlug(const std::string &slug)
Returns a string containing only the valid slug characters.

rack::plugin::isSlugValid
bool isSlugValid(const std::string &slug)
Checks that the slug contains only alphanumeric characters, "-", and "_".

rack::plugin::getModelFallback
Model * getModelFallback(const std::string &pluginSlug, const std::string &modelSlug)
Finds a loaded Model by plugin and model slug, or a fallback model if exists.

rack::plugin::settingsMergeJson
PRIVATE void settingsMergeJson(json_t *rootJ)

rack::plugin::init
PRIVATE void init()

rack::plugin::getPlugin
Plugin * getPlugin(const std::string &pluginSlug)
Finds a loaded Plugin by slug.

rack::plugin::pluginsPath
std::string pluginsPath
Path to plugins installation dir.

rack::plugin::getPluginFallback
Plugin * getPluginFallback(const std::string &pluginSlug)
Finds a loaded Plugin by slug, or a fallback plugin if exists.

rack::plugin::modelFromJson
Model * modelFromJson(json_t *moduleJ)
Creates a Model from a JSON module object.

rack::plugin::destroy
PRIVATE void destroy()

rack
Root namespace for the Rack API.
Definition AudioDisplay.hpp:9

rack::plugin::Model
Type information for a module.
Definition Model.hpp:34

rack::plugin::Plugin
Definition Plugin.hpp:17