Host Requirements

Requirements

(Examples)

• Can load plugin from URL
• Can read description of plugin prior to instantiation (descriptor.json at the root of URL)
  • Version (mandatory)
  • Plugin URL for documentation (optional)
  • thumbnail
  • name of the main class (optional) or can be inferred from Vendor name and Plugin name if not present
  • Vendor name (mandatory)
  • Plugin name (mandatory)
  • name (optional) of the main JS file (or bundle), defaults to main.js
  • Description (optional)
• Can instantiate audio processing node for plugin
• Can instantiate GUI for plugin
• Can get plugin's metadata set programmatically with the API method getMetadata for example. See metadata plugin tester and also this plugin API tester tested for mandatory methods in the API (most of them inherited from SDK)
  • Can iterate list of parameters in plugin
  • Can get type of parameter (discrete, continuous, etc.), see for example Juce param class hierarchy
  • Can set value with sample-rate accuracy
  • Can get the number of inputs and outputs
• Can ask a list of banks / patches
• Can set a patch (a preset, similar to a predefined state cf below)
• Can save/restore the state of a plugin (i.e when saving a host project). State = all parameter current values.