The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
More...
#include <juce_AudioPluginFormat.h>
|
| ~AudioPluginFormat () override |
| Destructor. More...
|
|
virtual bool | canScanForPlugins () const =0 |
| Returns true if this format needs to run a scan to find its list of plugins. More...
|
|
std::unique_ptr< AudioPluginInstance > | createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize) |
| Tries to recreate a type from a previously generated PluginDescription. More...
|
|
std::unique_ptr< AudioPluginInstance > | createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize, String &errorMessage) |
| Same as above but with the possibility of returning an error message. More...
|
|
void | createPluginInstanceAsync (const PluginDescription &description, double initialSampleRate, int initialBufferSize, PluginCreationCallback) |
| Tries to recreate a type from a previously generated PluginDescription. More...
|
|
virtual bool | doesPluginStillExist (const PluginDescription &)=0 |
| Checks whether this plugin could possibly be loaded. More...
|
|
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. More...
|
|
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. More...
|
|
virtual FileSearchPath | getDefaultLocationsToSearch ()=0 |
| Returns the typical places to look for this kind of plugin. More...
|
|
virtual String | getName () const =0 |
| Returns the format name. More...
|
|
virtual String | getNameOfPluginFromIdentifier (const String &fileOrIdentifier)=0 |
| Returns a readable version of the name of the plugin that this identifier refers to. More...
|
|
virtual bool | isTrivialToScan () const =0 |
| Should return true if this format is both safe and quick to scan - i.e. More...
|
|
virtual bool | pluginNeedsRescanning (const PluginDescription &)=0 |
| Returns true if this plugin's version or date has changed and it should be re-checked. More...
|
|
virtual bool | requiresUnblockedMessageThreadDuringCreation (const PluginDescription &) const =0 |
| Returns true if instantiation of this plugin type must be done from a non-message thread. More...
|
|
virtual StringArray | searchPathsForPlugins (const FileSearchPath &directoriesToSearch, bool recursive, bool allowPluginsWhichRequireAsynchronousInstantiation=false)=0 |
| Searches a suggested set of directories for any plugins in this format. More...
|
|
The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
- See also
- AudioPluginFormatManager
@tags{Audio}
◆ PluginCreationCallback
◆ ~AudioPluginFormat()
juce::AudioPluginFormat::~AudioPluginFormat |
( |
| ) |
|
|
override |
◆ AudioPluginFormat()
juce::AudioPluginFormat::AudioPluginFormat |
( |
| ) |
|
|
protected |
◆ 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.
Implemented in juce::VSTPluginFormat.
◆ createInstanceFromDescription() [1/2]
Tries to recreate a type from a previously generated PluginDescription.
- See also
- AudioPluginFormatManager::createInstance
◆ createInstanceFromDescription() [2/2]
Same as above but with the possibility of returning an error message.
- See also
- AudioPluginFormatManager::createInstance
◆ createPluginInstance()
Implementors must override this function.
This is guaranteed to be called on the message thread. You may call the callback on any thread.
Implemented in juce::VSTPluginFormat.
◆ createPluginInstanceAsync()
◆ doesPluginStillExist()
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.
Implemented in juce::VSTPluginFormat.
◆ 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.
Implemented in juce::VSTPluginFormat.
◆ 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.
Implemented in juce::VSTPluginFormat.
◆ 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.
Implemented in juce::VSTPluginFormat.
◆ getName()
virtual String juce::AudioPluginFormat::getName |
( |
| ) |
const |
|
pure virtual |
◆ 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.
Implemented in juce::VSTPluginFormat.
◆ handleMessage()
void juce::AudioPluginFormat::handleMessage |
( |
const Message & |
message | ) |
|
|
overrideprivatevirtual |
◆ isTrivialToScan()
virtual bool juce::AudioPluginFormat::isTrivialToScan |
( |
| ) |
const |
|
pure virtual |
Should return true if this format is both safe and quick to scan - i.e.
if a file can be scanned within a few milliseconds on a background thread, without actually needing to load an executable.
Implemented in juce::VSTPluginFormat.
◆ pluginNeedsRescanning()
Returns true if this plugin's version or date has changed and it should be re-checked.
Implemented in juce::VSTPluginFormat.
◆ postMessage()
void juce::MessageListener::postMessage |
( |
Message * |
message | ) |
const |
|
inherited |
Sends a message to the message queue, for asynchronous delivery to this listener later on.
This method can be called safely by any thread.
- Parameters
-
message | the message object to send - this will be deleted automatically by the message queue, so make sure it's allocated on the heap, not the stack! |
- See also
- handleMessage
◆ requiresUnblockedMessageThreadDuringCreation()
virtual bool juce::AudioPluginFormat::requiresUnblockedMessageThreadDuringCreation |
( |
const PluginDescription & |
| ) |
const |
|
pure virtual |
Returns true if instantiation of this plugin type must be done from a non-message thread.
Implemented in juce::VSTPluginFormat.
◆ searchPathsForPlugins()
virtual StringArray juce::AudioPluginFormat::searchPathsForPlugins |
( |
const FileSearchPath & |
directoriesToSearch, |
|
|
bool |
recursive, |
|
|
bool |
allowPluginsWhichRequireAsynchronousInstantiation = false |
|
) |
| |
|
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.
- Parameters
-
directoriesToSearch | This specifies which directories shall be searched for plug-ins. |
recursive | Should the search recursively traverse folders. |
allowPluginsWhichRequireAsynchronousInstantiation | If this is false then plug-ins which require asynchronous creation will be excluded. |
Implemented in juce::VSTPluginFormat.
◆ AudioPluginFormatManager
◆ masterReference
The documentation for this class was generated from the following file: