JUCE: VST3ClientExtensions Struct Reference

JUCE

Public Member Functions | List of all members
VST3ClientExtensions Struct Reference
juce_audio_processors » utilities

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

`#include <juce_VST3ClientExtensions.h>`

## Public Member Functions
virtual | ~VST3ClientExtensions ()=default
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. More...
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. More...
virtual void | setIComponentHandler (Steinberg::FUnknown *)
| This may be called by the VST3 wrapper when the host sets an IComponentHandler for the plugin to use. More...
virtual void | setIHostApplication (Steinberg::FUnknown *)
| This may be called shortly after the AudioProcessor is constructed with the current IHostApplication. More...
virtual bool | getPluginHasMainInput () const
| This function will be called to check whether the first input bus should be designated as "kMain" or "kAux". More...

## Detailed Description

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

To use this class, ensure that your AudioProcessor publicly inherits from VST3ClientExtensions.

See also
  VSTCallbackHandler

## Constructor & Destructor Documentation

## ◆ ~VST3ClientExtensions()

virtual VST3ClientExtensions::~VST3ClientExtensions | ( |  | ) |
| virtualdefault

## Member Function Documentation

## ◆ queryIEditController()

virtual int32_t 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.

References gl::obj.

## ◆ queryIAudioProcessor()

virtual int32_t 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.

References gl::obj.

## ◆ setIComponentHandler()

virtual void 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!

## ◆ setIHostApplication()

virtual void 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!

## ◆ getPluginHasMainInput()

virtual bool 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.

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

- juce_VST3ClientExtensions.h