JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
juce::VST3ClientExtensions Struct Reference

An interface to allow an AudioProcessor to implement extended VST3-specific functionality. More...

#include "juce_VST3ClientExtensions.h"

Public Member Functions

virtual int32_t queryIEditController (const Steinberg::TUID, void **obj)
 This function may be used by implementations of queryInterface() in the VST3's implementation of IEditController to return additional supported interfaces.
 
virtual int32_t queryIAudioProcessor (const Steinberg::TUID, void **obj)
 This function may be used by implementations of queryInterface() in the VST3's implementation of IAudioProcessor to return additional supported interfaces.
 
virtual void setIComponentHandler (Steinberg::FUnknown *)
 This may be called by the VST3 wrapper when the host sets an IComponentHandler for the plugin to use.
 
virtual void setIHostApplication (Steinberg::FUnknown *)
 This may be called shortly after the AudioProcessor is constructed with the current IHostApplication.
 
virtual bool getPluginHasMainInput () const
 This function will be called to check whether the first input bus should be designated as "kMain" or "kAux".
 
virtual std::vector< String > getCompatibleClasses () const
 This function should return the UIDs of any compatible VST2 plug-ins.
 

Detailed Description

An interface to allow an AudioProcessor to implement extended VST3-specific functionality.

To use this class, create an object that inherits from it, implement the methods, then return a pointer to the object in your AudioProcessor::getVST3ClientExtensions() method.

See also
AudioProcessor, AAXClientExtensions, VST2ClientExtensions

@tags{Audio}

Definition at line 50 of file juce_VST3ClientExtensions.h.

Member Function Documentation

◆ getCompatibleClasses()

virtual std::vector< String > juce::VST3ClientExtensions::getCompatibleClasses ( ) const
virtual

This function should return the UIDs of any compatible VST2 plug-ins.

Each item in the vector should be a 32-character string consisting only of the characters 0-9 and A-F.

This information will be used to implement the IPluginCompatibility interface. Hosts can use this interface to determine whether this VST3 is capable of replacing a given VST2.

Definition at line 107 of file juce_VST3ClientExtensions.h.

◆ getPluginHasMainInput()

virtual bool juce::VST3ClientExtensions::getPluginHasMainInput ( ) const
virtual

This function will be called to check whether the first input bus should be designated as "kMain" or "kAux".

Return true if the first bus should be kMain, or false if the bus should be kAux.

All other input buses will always be designated kAux.

Definition at line 96 of file juce_VST3ClientExtensions.h.

◆ queryIAudioProcessor()

virtual int32_t juce::VST3ClientExtensions::queryIAudioProcessor ( const Steinberg::TUID  ,
void **  obj 
)
virtual

This function may be used by implementations of queryInterface() in the VST3's implementation of IAudioProcessor to return additional supported interfaces.

Definition at line 68 of file juce_VST3ClientExtensions.h.

◆ queryIEditController()

virtual int32_t juce::VST3ClientExtensions::queryIEditController ( const Steinberg::TUID  ,
void **  obj 
)
virtual

This function may be used by implementations of queryInterface() in the VST3's implementation of IEditController to return additional supported interfaces.

Definition at line 58 of file juce_VST3ClientExtensions.h.

◆ setIComponentHandler()

virtual void juce::VST3ClientExtensions::setIComponentHandler ( Steinberg::FUnknown *  )
virtual

This may be called by the VST3 wrapper when the host sets an IComponentHandler for the plugin to use.

You should not make any assumptions about how and when this will be called - this function may not be called at all!

Definition at line 80 of file juce_VST3ClientExtensions.h.

◆ setIHostApplication()

virtual void juce::VST3ClientExtensions::setIHostApplication ( Steinberg::FUnknown *  )
virtual

This may be called shortly after the AudioProcessor is constructed with the current IHostApplication.

You should not make any assumptions about how and when this will be called - this function may not be called at all!

Definition at line 88 of file juce_VST3ClientExtensions.h.

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