juce::AudioPluginExtensions::VSTClient Struct Reference

Can be used to retrieve information about a VST that is wrapped by an AudioProcessor. More...

Classes
class	ExtraFunctions
	Base class for some extra functions that can be attached to a VST plugin instance. More...

Public Member Functions
virtual	~VSTClient ()=default
virtual AEffect *	getAEffectPtr () const noexcept=0
virtual const XmlElement *	getVSTXML () const =0
	Attempts to retrieve the VSTXML data from a plugin.
virtual bool	loadFromFXBFile (Span< const std::byte > data)=0
	Attempts to reload a VST plugin's state from some FXB or FXP data.
virtual bool	saveToFXBFile (MemoryBlock &result, bool asFXB)=0
	Attempts to save a VST's state to some FXP or FXB data.
virtual bool	setChunkData (Span< const std::byte > data, bool isPreset)=0
	Attempts to set a VST's state from a chunk of memory.
virtual bool	getChunkData (MemoryBlock &result, bool isPreset) const =0
	Attempts to get a VST's state as a chunk of memory.
virtual void	setExtraFunctions (std::unique_ptr< ExtraFunctions > functions)=0
	Provides an ExtraFunctions callback object for a plugin to use.
virtual pointer_sized_int	dispatcher (int32, int32, pointer_sized_int, void *, float)=0
	This simply calls directly to the VST's AEffect::dispatcher() function.

Detailed Description

Can be used to retrieve information about a VST that is wrapped by an AudioProcessor.

Constructor & Destructor Documentation

~VSTClient()

virtual juce::AudioPluginExtensions::VSTClient::~VSTClient ( )

virtualdefault

Member Function Documentation

getAEffectPtr()

virtual AEffect * juce::AudioPluginExtensions::VSTClient::getAEffectPtr ( ) const

pure virtualnoexcept

getVSTXML()

virtual const XmlElement * juce::AudioPluginExtensions::VSTClient::getVSTXML ( ) const

pure virtual

Attempts to retrieve the VSTXML data from a plugin.

Will return nullptr if the plugin doesn't have any VSTXML.

loadFromFXBFile()

virtual bool juce::AudioPluginExtensions::VSTClient::loadFromFXBFile ( Span< const std::byte >  data )

pure virtual

Attempts to reload a VST plugin's state from some FXB or FXP data.

saveToFXBFile()

virtual bool juce::AudioPluginExtensions::VSTClient::saveToFXBFile ( MemoryBlock &  result, bool  asFXB  )

pure virtual

Attempts to save a VST's state to some FXP or FXB data.

setChunkData()

virtual bool juce::AudioPluginExtensions::VSTClient::setChunkData ( Span< const std::byte >  data, bool  isPreset  )

pure virtual

Attempts to set a VST's state from a chunk of memory.

getChunkData()

virtual bool juce::AudioPluginExtensions::VSTClient::getChunkData ( MemoryBlock &  result, bool  isPreset  ) const

pure virtual

Attempts to get a VST's state as a chunk of memory.

setExtraFunctions()

virtual void juce::AudioPluginExtensions::VSTClient::setExtraFunctions ( std::unique_ptr< ExtraFunctions >  functions )

pure virtual

Provides an ExtraFunctions callback object for a plugin to use.

The plugin will take ownership of the object and will delete it automatically.

dispatcher()

virtual pointer_sized_int juce::AudioPluginExtensions::VSTClient::dispatcher ( int32  , int32  , pointer_sized_int  , void *  , float    )

pure virtual

This simply calls directly to the VST's AEffect::dispatcher() function.

---

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

• juce_audio_processors_headless/utilities/juce_AudioPluginExtensions.h