openshot-audio
0.1.4
|
#include <juce_audio_processors.h>
Public Member Functions | |
PluginDescription () | |
PluginDescription (const PluginDescription &other) | |
PluginDescription & | operator= (const PluginDescription &other) |
~PluginDescription () | |
bool | isDuplicateOf (const PluginDescription &other) const noexcept |
bool | matchesIdentifierString (const String &identifierString) const |
String | createIdentifierString () const |
XmlElement * | createXml () const |
bool | loadFromXml (const XmlElement &xml) |
Public Attributes | |
String | name |
String | descriptiveName |
String | pluginFormatName |
String | category |
String | manufacturerName |
String | version |
String | fileOrIdentifier |
Time | lastFileModTime |
int | uid |
bool | isInstrument |
int | numInputChannels |
int | numOutputChannels |
bool | hasSharedContainer |
A small class to represent some facts about a particular type of plug-in.
This class is for storing and managing the details about a plug-in without actually having to load an instance of it.
A KnownPluginList contains a list of PluginDescription objects.
PluginDescription::PluginDescription | ( | ) |
PluginDescription::PluginDescription | ( | const PluginDescription & | other | ) |
PluginDescription::~PluginDescription | ( | ) |
String PluginDescription::createIdentifierString | ( | ) | const |
Returns a string that can be saved and used to uniquely identify the plugin again.
This contains less info than the XML encoding, and is independent of the plug-in's file location, so can be used to store a plug-in ID for use across different machines.
XmlElement * PluginDescription::createXml | ( | ) | const |
Creates an XML object containing these details.
|
noexcept |
Returns true if the two descriptions refer to the same plug-in.
This isn't quite as simple as them just having the same file (because of shell plug-ins).
bool PluginDescription::loadFromXml | ( | const XmlElement & | xml | ) |
Reloads the info in this structure from an XML record that was previously saved with createXML().
Returns true if the XML was a valid plug-in description.
bool PluginDescription::matchesIdentifierString | ( | const String & | identifierString | ) | const |
Return true if this description is equivalent to another one which created the given identifier string.
Note that this isn't quite as simple as them just calling createIdentifierString() and comparing the strings, because the identifers can differ (thanks to shell plug-ins).
PluginDescription & PluginDescription::operator= | ( | const PluginDescription & | other | ) |
String juce::PluginDescription::category |
A category, such as "Dynamics", "Reverbs", etc.
String juce::PluginDescription::descriptiveName |
A more descriptive name for the plug-in. This may be the same as the 'name' field, but some plug-ins may provide an alternative name.
String juce::PluginDescription::fileOrIdentifier |
Either the file containing the plug-in module, or some other unique way of identifying it.
E.g. for an AU, this would be an ID string that the component manager could use to retrieve the plug-in. For a VST, it's the file path.
bool juce::PluginDescription::hasSharedContainer |
True if the plug-in is part of a multi-type container, e.g. a VST Shell.
bool juce::PluginDescription::isInstrument |
True if the plug-in identifies itself as a synthesiser.
Time juce::PluginDescription::lastFileModTime |
The last time the plug-in file was changed. This is handy when scanning for new or changed plug-ins.
String juce::PluginDescription::manufacturerName |
The manufacturer.
String juce::PluginDescription::name |
The name of the plug-in.
int juce::PluginDescription::numInputChannels |
The number of inputs.
int juce::PluginDescription::numOutputChannels |
The number of outputs.
String juce::PluginDescription::pluginFormatName |
The plug-in format, e.g. "VST", "AudioUnit", etc.
int juce::PluginDescription::uid |
A unique ID for the plug-in.
Note that this might not be unique between formats, e.g. a VST and some other format might actually have the same id.
String juce::PluginDescription::version |
The version. This string doesn't have any particular format.