juce::PluginDescription Class Reference

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

#include <juce_PluginDescription.h>

Collaboration diagram for juce::PluginDescription:

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

Public Attributes
String	category
	A category, such as "Dynamics", "Reverbs", etc. More...
int	deprecatedUid = 0
	Deprecated: New projects should use uniqueId instead. More...
String	descriptiveName
	A more descriptive name for the plug-in. More...
String	fileOrIdentifier
	Either the file containing the plug-in module, or some other unique way of identifying it. More...
bool	hasSharedContainer = false
	True if the plug-in is part of a multi-type container, e.g. More...
bool	isInstrument = false
	True if the plug-in identifies itself as a synthesiser. More...
Time	lastFileModTime
	The last time the plug-in file was changed. More...
Time	lastInfoUpdateTime
	The last time that this information was updated. More...
String	manufacturerName
	The manufacturer. More...
String	name
	The name of the plug-in. More...
int	numInputChannels = 0
	The number of inputs. More...
int	numOutputChannels = 0
	The number of outputs. More...
String	pluginFormatName
	The plug-in format, e.g. More...
int	uniqueId = 0
	A unique ID for the plug-in. More...
String	version
	The version. 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

@tags{Audio}

Constructor & Destructor Documentation

PluginDescription() [1/3]

juce::PluginDescription::PluginDescription ( )

default

PluginDescription() [2/3]

juce::PluginDescription::PluginDescription ( const PluginDescription &  )

default

PluginDescription() [3/3]

juce::PluginDescription::PluginDescription ( PluginDescription &&  )

default

Member Function Documentation

createIdentifierString()

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.

createXml()

std::unique_ptr<XmlElement> juce::PluginDescription::createXml

(

)

const

Creates an XML object containing these details.

See also

loadFromXml

isDuplicateOf()

bool juce::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).

loadFromXml()

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.

matchesIdentifierString()

bool juce::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).

operator=() [1/2]

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

default

operator=() [2/2]

PluginDescription& juce::PluginDescription::operator= ( PluginDescription &&  )

default

Member Data Documentation

category

String juce::PluginDescription::category

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

deprecatedUid

int juce::PluginDescription::deprecatedUid = 0

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.

See also

createIdentifierString

descriptiveName

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.

fileOrIdentifier

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.

hasSharedContainer

bool juce::PluginDescription::hasSharedContainer = false

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

a VST Shell.

isInstrument

bool juce::PluginDescription::isInstrument = false

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

lastFileModTime

Time juce::PluginDescription::lastFileModTime

The last time the plug-in file was changed.

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

lastInfoUpdateTime

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.

manufacturerName

String juce::PluginDescription::manufacturerName

The manufacturer.

name

String juce::PluginDescription::name

The name of the plug-in.

numInputChannels

int juce::PluginDescription::numInputChannels = 0

The number of inputs.

numOutputChannels

int juce::PluginDescription::numOutputChannels = 0

The number of outputs.

pluginFormatName

String juce::PluginDescription::pluginFormatName

The plug-in format, e.g.

"VST", "AudioUnit", etc.

uniqueId

int juce::PluginDescription::uniqueId = 0

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.

See also

createIdentifierString

version

String juce::PluginDescription::version

The version.

This string doesn't have any particular format.

---

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

• juce_PluginDescription.h