#include <juce_audio_processors.h>
The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
- See also
- AudioFormatManager
◆ ~AudioPluginFormat()
AudioPluginFormat::~AudioPluginFormat |
( |
| ) |
|
|
virtual |
◆ AudioPluginFormat()
AudioPluginFormat::AudioPluginFormat |
( |
| ) |
|
|
protectednoexcept |
◆ canScanForPlugins()
virtual bool juce::AudioPluginFormat::canScanForPlugins |
( |
| ) |
const |
|
pure virtual |
Returns true if this format needs to run a scan to find its list of plugins.
◆ createInstanceFromDescription()
Tries to recreate a type from a previously generated PluginDescription.
- See also
- PluginDescription::createInstance
◆ doesPluginStillExist()
virtual bool juce::AudioPluginFormat::doesPluginStillExist |
( |
const PluginDescription & |
desc | ) |
|
|
pure virtual |
Checks whether this plugin could possibly be loaded. It doesn't actually need to load it, just to check whether the file or component still exists.
◆ fileMightContainThisPluginType()
virtual bool juce::AudioPluginFormat::fileMightContainThisPluginType |
( |
const String & |
fileOrIdentifier | ) |
|
|
pure virtual |
Should do a quick check to see if this file or directory might be a plugin of this format.
This is for searching for potential files, so it shouldn't actually try to load the plugin or do anything time-consuming.
◆ findAllTypesForFile()
This tries to create descriptions for all the plugin types available in a binary module file.
The file will be some kind of DLL or bundle.
Normally there will only be one type returned, but some plugins (e.g. VST shells) can use a single DLL to create a set of different plugin subtypes, so in that case, each subtype is returned as a separate object.
◆ getDefaultLocationsToSearch()
virtual FileSearchPath juce::AudioPluginFormat::getDefaultLocationsToSearch |
( |
| ) |
|
|
pure virtual |
Returns the typical places to look for this kind of plugin.
Note that if this returns no paths, it means that the format doesn't search in files or folders, e.g. AudioUnits.
◆ getName()
virtual String juce::AudioPluginFormat::getName |
( |
| ) |
const |
|
pure virtual |
Returns the format name. E.g. "VST", "AudioUnit", etc.
◆ getNameOfPluginFromIdentifier()
virtual String juce::AudioPluginFormat::getNameOfPluginFromIdentifier |
( |
const String & |
fileOrIdentifier | ) |
|
|
pure virtual |
Returns a readable version of the name of the plugin that this identifier refers to.
◆ pluginNeedsRescanning()
virtual bool juce::AudioPluginFormat::pluginNeedsRescanning |
( |
const PluginDescription & |
| ) |
|
|
pure virtual |
Returns true if this plugin's version or date has changed and it should be re-checked.
◆ searchPathsForPlugins()
virtual StringArray juce::AudioPluginFormat::searchPathsForPlugins |
( |
const FileSearchPath & |
directoriesToSearch, |
|
|
bool |
recursive |
|
) |
| |
|
pure virtual |
Searches a suggested set of directories for any plugins in this format. The path might be ignored, e.g. by AUs, which are found by the OS rather than manually.
The documentation for this class was generated from the following files: