#include <juce_AudioPluginFormat.h>
|
| | ~AudioPluginFormat () override |
| virtual String | getName () const =0 |
| virtual void | findAllTypesForFile (OwnedArray< PluginDescription > &results, const String &fileOrIdentifier)=0 |
| std::unique_ptr< AudioPluginInstance > | createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize) |
| std::unique_ptr< AudioPluginInstance > | createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize, String &errorMessage) |
| void | createPluginInstanceAsync (const PluginDescription &description, double initialSampleRate, int initialBufferSize, PluginCreationCallback) |
| virtual bool | fileMightContainThisPluginType (const String &fileOrIdentifier)=0 |
| virtual String | getNameOfPluginFromIdentifier (const String &fileOrIdentifier)=0 |
| virtual bool | pluginNeedsRescanning (const PluginDescription &)=0 |
| virtual bool | doesPluginStillExist (const PluginDescription &)=0 |
| virtual bool | canScanForPlugins () const =0 |
| virtual bool | isTrivialToScan () const =0 |
| virtual StringArray | searchPathsForPlugins (const FileSearchPath &directoriesToSearch, bool recursive, bool allowPluginsWhichRequireAsynchronousInstantiation=false)=0 |
| virtual FileSearchPath | getDefaultLocationsToSearch ()=0 |
| virtual bool | requiresUnblockedMessageThreadDuringCreation (const PluginDescription &) const =0 |
| virtual void | createARAFactoryAsync (const PluginDescription &, ARAFactoryCreationCallback callback) |
The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
- See also
- AudioPluginFormatManager
@tags{Audio}
◆ ARAFactoryCreationCallback
A callback lambda that is passed to getARAFactory()
◆ PluginCreationCallback
A callback lambda that is passed to createPluginInstanceAsync()
◆ ~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.
◆ createARAFactoryAsync()
Tries to create an ::ARAFactoryWrapper for this description.
The result of the operation will be wrapped into an ARAFactoryResult, which will be passed to a callback object supplied by the caller.
- See also
- AudioPluginFormatManager::createARAFactoryAsync
◆ 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.
◆ createPluginInstanceAsync()
Tries to recreate a type from a previously generated PluginDescription. When the plugin has been created, it will be passed to the caller via an asynchronous call to the PluginCreationCallback lambda that was provided.
- See also
- AudioPluginFormatManager::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.
◆ 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.
◆ handleMessage()
This is the callback method that receives incoming messages.
This is called by the MessageManager from its dispatch loop.
- See also
- postMessage
Implements juce::MessageListener.
◆ 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.
◆ pluginNeedsRescanning()
Returns true if this plugin's version or date has changed and it should be re-checked.
◆ 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.
◆ 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. |
◆ AudioPluginFormatManager
| friend class AudioPluginFormatManager |
|
friend |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format/juce_AudioPluginFormat.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format/juce_AudioPluginFormat.cpp
1.16.1