PluginDescription Class Reference

A small class to represent some facts about a particular type of plugin. More...

List of all members.

Public Member Functions
	PluginDescription ()
	PluginDescription (const PluginDescription &other)
PluginDescription &	operator= (const PluginDescription &other)
	~PluginDescription ()
bool	isDuplicateOf (const PluginDescription &other) const
	Returns true if the two descriptions refer the the same plugin.
String	createIdentifierString () const
	Returns a string that can be saved and used to uniquely identify the plugin again.
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 plugin.
String	descriptiveName
	A more descriptive name for the plugin.
String	pluginFormatName
	The plugin 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 plugin module, or some other unique way of identifying it.
Time	lastFileModTime
	The last time the plugin file was changed.
int	uid
	A unique ID for the plugin.
bool	isInstrument
	True if the plugin identifies itself as a synthesiser.
int	numInputChannels
	The number of inputs.
int	numOutputChannels
	The number of outputs.

---

Detailed Description

A small class to represent some facts about a particular type of plugin.

This class is for storing and managing the details about a plugin without actually having to load an instance of it.

A KnownPluginList contains a list of PluginDescription objects.

See also:

KnownPluginList

---

Constructor & Destructor Documentation

PluginDescription::PluginDescription

(

)

PluginDescription::PluginDescription

(

const PluginDescription &

other )

PluginDescription::~PluginDescription

(

)

---

Member Function Documentation

PluginDescription& PluginDescription::operator=

(

const PluginDescription &

other )

bool PluginDescription::isDuplicateOf

(

const PluginDescription &

other )

const

Returns true if the two descriptions refer the the same plugin.

This isn't quite as simple as them just having the same file (because of shell plugins).

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 plugin's file location, so can be used to store a plugin ID for use across different machines.

XmlElement* PluginDescription::createXml

(

)

const

Creates an XML object containing these details.

See also:

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 plugin description.

---

Member Data Documentation

String PluginDescription::name

The name of the plugin.

String PluginDescription::descriptiveName

A more descriptive name for the plugin.

This may be the same as the 'name' field, but some plugins may provide an alternative name.

String PluginDescription::pluginFormatName

The plugin format, e.g.

"VST", "AudioUnit", etc.

String PluginDescription::category

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

String PluginDescription::manufacturerName

The manufacturer.

String PluginDescription::version

The version.

This string doesn't have any particular format.

String PluginDescription::fileOrIdentifier

Either the file containing the plugin 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 plugin. For a VST, it's the file path.

Time PluginDescription::lastFileModTime

The last time the plugin file was changed.

This is handy when scanning for new or changed plugins.

int PluginDescription::uid

A unique ID for the plugin.

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

bool PluginDescription::isInstrument

True if the plugin identifies itself as a synthesiser.

int PluginDescription::numInputChannels

The number of inputs.

int PluginDescription::numOutputChannels

The number of outputs.

---

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

• juce_PluginDescription.h