A small class to represent some facts about a particular type of plug-in. More...

Public Member Functions

 PluginDescription ()
 
 PluginDescription (const PluginDescription &other)
 
PluginDescriptionoperator= (const PluginDescription &other)
 
 ~PluginDescription ()
 
bool isDuplicateOf (const PluginDescription &other) const noexcept
 Returns true if the two descriptions refer to the same plug-in. More...
 
bool matchesIdentifierString (const String &identifierString) const
 Return true if this description is equivalent to another one which created the given identifier string. More...
 
String createIdentifierString () const
 Returns a string that can be saved and used to uniquely identify the plugin again. More...
 
XmlElementcreateXml () const
 Creates an XML object containing these details. More...
 
bool loadFromXml (const XmlElement &xml)
 Reloads the info in this structure from an XML record that was previously saved with createXML(). More...
 

Public Attributes

String name
 The name of the plug-in. More...
 
String descriptiveName
 A more descriptive name for the plug-in. More...
 
String pluginFormatName
 The plug-in format, e.g. More...
 
String category
 A category, such as "Dynamics", "Reverbs", etc. More...
 
String manufacturerName
 The manufacturer. More...
 
String version
 The version. More...
 
String fileOrIdentifier
 Either the file containing the plug-in module, or some other unique way of identifying it. More...
 
Time lastFileModTime
 The last time the plug-in file was changed. More...
 
Time lastInfoUpdateTime
 The last time that this information was updated. More...
 
int uid
 A unique ID for the plug-in. More...
 
bool isInstrument
 True if the plug-in identifies itself as a synthesiser. More...
 
int numInputChannels
 The number of inputs. More...
 
int numOutputChannels
 The number of outputs. More...
 
bool hasSharedContainer
 True if the plug-in is part of a multi-type container, e.g. More...
 

Detailed Description

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.

See also
KnownPluginList

Constructor & Destructor Documentation

◆ PluginDescription() [1/2]

PluginDescription::PluginDescription ( )

◆ PluginDescription() [2/2]

PluginDescription::PluginDescription ( const PluginDescription other)

◆ ~PluginDescription()

PluginDescription::~PluginDescription ( )

Member Function Documentation

◆ operator=()

PluginDescription& PluginDescription::operator= ( const PluginDescription other)

◆ isDuplicateOf()

bool PluginDescription::isDuplicateOf ( const PluginDescription other) const
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).

◆ matchesIdentifierString()

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 identifiers can differ (thanks to shell plug-ins).

◆ createIdentifierString()

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.

◆ createXml()

XmlElement* PluginDescription::createXml ( ) const

Creates an XML object containing these details.

See also
loadFromXml

◆ loadFromXml()

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.

Member Data Documentation

◆ name

String PluginDescription::name

The name of the plug-in.

◆ descriptiveName

String 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.

◆ pluginFormatName

String PluginDescription::pluginFormatName

The plug-in format, e.g.

"VST", "AudioUnit", etc.

◆ category

String PluginDescription::category

A category, such as "Dynamics", "Reverbs", etc.

◆ manufacturerName

String PluginDescription::manufacturerName

The manufacturer.

◆ version

String PluginDescription::version

The version.

This string doesn't have any particular format.

◆ fileOrIdentifier

String 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.

◆ lastFileModTime

Time PluginDescription::lastFileModTime

The last time the plug-in file was changed.

This is handy when scanning for new or changed plug-ins.

◆ lastInfoUpdateTime

Time 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.

◆ uid

int 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.

See also
createIdentifierString

◆ isInstrument

bool PluginDescription::isInstrument

True if the plug-in identifies itself as a synthesiser.

◆ numInputChannels

int PluginDescription::numInputChannels

The number of inputs.

◆ numOutputChannels

int PluginDescription::numOutputChannels

The number of outputs.

◆ hasSharedContainer

bool PluginDescription::hasSharedContainer

True if the plug-in is part of a multi-type container, e.g.

a VST Shell.


The documentation for this class was generated from the following file: