|
JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins
« « « Anklang Documentation |
A small class to represent some facts about a particular type of plug-in. More...
#include "juce_PluginDescription.h"
Public Member Functions | |
| PluginDescription (const PluginDescription &)=default | |
| PluginDescription (PluginDescription &&)=default | |
| PluginDescription & | operator= (const PluginDescription &)=default |
| PluginDescription & | operator= (PluginDescription &&)=default |
| bool | isDuplicateOf (const PluginDescription &other) const noexcept |
| Returns true if the two descriptions refer to the same plug-in. | |
| bool | matchesIdentifierString (const String &identifierString) const |
| Return true if this description is equivalent to another one which created the given identifier string. | |
| String | createIdentifierString () const |
| Returns a string that can be saved and used to uniquely identify the plugin again. | |
| std::unique_ptr< XmlElement > | createXml () const |
| Creates an XML object containing these details. | |
| bool | loadFromXml (const XmlElement &xml) |
| Reloads the info in this structure from an XML record that was previously saved with createXML(). | |
Public Attributes | |
| String | name |
| The name of the plug-in. | |
| String | descriptiveName |
| A more descriptive name for the plug-in. | |
| String | pluginFormatName |
| The plug-in format, e.g. | |
| String | category |
| A category, such as "Dynamics", "Reverbs", etc. | |
| String | manufacturerName |
| The manufacturer. | |
| String | version |
| The version. | |
| String | fileOrIdentifier |
| Either the file containing the plug-in module, or some other unique way of identifying it. | |
| Time | lastFileModTime |
| The last time the plug-in file was changed. | |
| Time | lastInfoUpdateTime |
| The last time that this information was updated. | |
| int | deprecatedUid |
| Deprecated: New projects should use uniqueId instead. | |
| int | uniqueId |
| A unique ID for the plug-in. | |
| bool | isInstrument |
| True if the plug-in identifies itself as a synthesiser. | |
| int | numInputChannels |
| The number of inputs. | |
| int | numOutputChannels |
| The number of outputs. | |
| bool | hasSharedContainer |
| True if the plug-in is part of a multi-type container, e.g. | |
| bool | hasARAExtension |
| True if the plug-in is ARA enabled and can supply a valid ARAFactoryWrapper. | |
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.
@tags{Audio}
Definition at line 42 of file juce_PluginDescription.h.
| String juce::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.
Definition at line 55 of file juce_PluginDescription.cpp.
| std::unique_ptr< XmlElement > juce::PluginDescription::createXml | ( | ) | const |
Creates an XML object containing these details.
Definition at line 61 of file juce_PluginDescription.cpp.
|
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).
Definition at line 29 of file juce_PluginDescription.cpp.
| bool juce::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.
Definition at line 89 of file juce_PluginDescription.cpp.
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 identifiers can differ (thanks to shell plug-ins).
Definition at line 45 of file juce_PluginDescription.cpp.
| String juce::PluginDescription::category |
A category, such as "Dynamics", "Reverbs", etc.
Definition at line 68 of file juce_PluginDescription.h.
| int juce::PluginDescription::deprecatedUid |
Deprecated: New projects should use uniqueId instead.
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.
Definition at line 103 of file juce_PluginDescription.h.
| 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.
Definition at line 62 of file juce_PluginDescription.h.
| 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.
Definition at line 82 of file juce_PluginDescription.h.
| bool juce::PluginDescription::hasARAExtension |
True if the plug-in is ARA enabled and can supply a valid ARAFactoryWrapper.
Definition at line 133 of file juce_PluginDescription.h.
| bool juce::PluginDescription::hasSharedContainer |
True if the plug-in is part of a multi-type container, e.g.
a VST Shell.
Definition at line 130 of file juce_PluginDescription.h.
| bool juce::PluginDescription::isInstrument |
True if the plug-in identifies itself as a synthesiser.
Definition at line 121 of file juce_PluginDescription.h.
| Time juce::PluginDescription::lastFileModTime |
The last time the plug-in file was changed.
This is handy when scanning for new or changed plug-ins.
Definition at line 87 of file juce_PluginDescription.h.
| Time juce::PluginDescription::lastInfoUpdateTime |
The last time that this information was updated.
This would typically have been during a scan when this plugin was first tested or found to have changed.
Definition at line 92 of file juce_PluginDescription.h.
| String juce::PluginDescription::manufacturerName |
The manufacturer.
Definition at line 71 of file juce_PluginDescription.h.
| String juce::PluginDescription::name |
The name of the plug-in.
Definition at line 56 of file juce_PluginDescription.h.
| int juce::PluginDescription::numInputChannels |
The number of inputs.
Definition at line 124 of file juce_PluginDescription.h.
| int juce::PluginDescription::numOutputChannels |
The number of outputs.
Definition at line 127 of file juce_PluginDescription.h.
| String juce::PluginDescription::pluginFormatName |
The plug-in format, e.g.
"VST", "AudioUnit", etc.
Definition at line 65 of file juce_PluginDescription.h.
| int juce::PluginDescription::uniqueId |
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.
The uniqueId field replaces the deprecatedUid field, and fixes an issue where VST3 plugins with matching FUIDs would generate different uid values depending on the platform. The deprecatedUid field is kept for backwards compatibility, allowing existing hosts to migrate from the old uid to the new uniqueId.
Definition at line 118 of file juce_PluginDescription.h.
| String juce::PluginDescription::version |
The version.
This string doesn't have any particular format.
Definition at line 74 of file juce_PluginDescription.h.