The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc. More...
Public Member Functions | |
| virtual | ~AudioPluginFormat () |
| Destructor. | |
| virtual String | getName () const =0 |
| Returns the format name. | |
| virtual void | findAllTypesForFile (OwnedArray< PluginDescription > &results, const String &fileOrIdentifier)=0 |
| This tries to create descriptions for all the plugin types available in a binary module file. | |
| virtual AudioPluginInstance * | createInstanceFromDescription (const PluginDescription &desc)=0 |
| Tries to recreate a type from a previously generated PluginDescription. | |
| virtual bool | fileMightContainThisPluginType (const String &fileOrIdentifier)=0 |
| Should do a quick check to see if this file or directory might be a plugin of this format. | |
| virtual String | getNameOfPluginFromIdentifier (const String &fileOrIdentifier)=0 |
| Returns a readable version of the name of the plugin that this identifier refers to. | |
| virtual bool | doesPluginStillExist (const PluginDescription &desc)=0 |
| Checks whether this plugin could possibly be loaded. | |
| virtual StringArray | searchPathsForPlugins (const FileSearchPath &directoriesToSearch, bool recursive)=0 |
| Searches a suggested set of directories for any plugins in this format. | |
| virtual FileSearchPath | getDefaultLocationsToSearch ()=0 |
| Returns the typical places to look for this kind of plugin. | |
Protected Member Functions | |
| AudioPluginFormat () noexcept | |
| JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioPluginFormat) | |
The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
Use the static getNumFormats() and getFormat() calls to find the types of format that are available.
| virtual AudioPluginFormat::~AudioPluginFormat | ( | ) | [virtual] |
Destructor.
| AudioPluginFormat::AudioPluginFormat | ( | ) | [protected] |
| virtual String AudioPluginFormat::getName | ( | ) | const [pure virtual] |
Returns the format name.
E.g. "VST", "AudioUnit", etc.
| virtual void AudioPluginFormat::findAllTypesForFile | ( | OwnedArray< PluginDescription > & | results, |
| const String & | fileOrIdentifier | ||
| ) | [pure virtual] |
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.
| virtual AudioPluginInstance* AudioPluginFormat::createInstanceFromDescription | ( | const PluginDescription & | desc ) | [pure virtual] |
Tries to recreate a type from a previously generated PluginDescription.
| virtual bool 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.
| virtual String AudioPluginFormat::getNameOfPluginFromIdentifier | ( | const String & | fileOrIdentifier ) | [pure virtual] |
Returns a readable version of the name of the plugin that this identifier refers to.
| virtual bool 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.
| virtual StringArray 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.
| virtual FileSearchPath 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 can't be scanned-for (i.e. it's an internal format that doesn't live in files)
| AudioPluginFormat::JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR | ( | AudioPluginFormat | ) | [protected] |
