|
VST 3 Interfaces
VST 3.6.14
SDK for developing VST Plug-in
|
|
VST 3 Interfaces
VST 3.6.14
SDK for developing VST Plug-in
|
Audio Processing Interface. More...
#include <ivstaudioprocessor.h>
Inheritance diagram for IAudioProcessor:Public Member Functions | |
| virtual tresult | setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts)=0 |
| Try to set (from host) a predefined arrangement for inputs and outputs. More... | |
| virtual tresult | getBusArrangement (BusDirection dir, int32 index, SpeakerArrangement &arr)=0 |
| Gets the bus arrangement for a given direction (input/output) and index. More... | |
| virtual tresult | canProcessSampleSize (int32 symbolicSampleSize)=0 |
| Asks if a given sample size is supported see SymbolicSampleSizes. More... | |
| virtual uint32 | getLatencySamples ()=0 |
| Gets the current Latency in samples. More... | |
| virtual tresult | setupProcessing (ProcessSetup &setup)=0 |
| Called in disable state (setActive not called with true) before setProcessing is called and processing will begin. More... | |
| virtual tresult | setProcessing (TBool state)=0 |
| Informs the Plug-in about the processing state. More... | |
| virtual tresult | process (ProcessData &data)=0 |
| The Process call, where all information (parameter changes, event, audio buffer) are passed. More... | |
| virtual uint32 | getTailSamples ()=0 |
| Gets tail size in samples. More... | |
| Public Member Functions inherited from FUnknown | |
| virtual tresult | queryInterface (const TUID _iid, void **obj)=0 |
| virtual uint32 | addRef ()=0 |
| virtual uint32 | release ()=0 |
Static Public Attributes | |
| static const FUID | iid |
| Static Public Attributes inherited from FUnknown | |
| static const FUID | iid |
Audio Processing Interface.
This interface must always be supported by audio processing Plug-ins.
|
pure virtual |
Try to set (from host) a predefined arrangement for inputs and outputs.
The host should always deliver the same number of input and output buses than the Plug-in needs (see IComponent::getBusCount). The Plug-in returns kResultFalse if wanted arrangements are not supported. If the Plug-in accepts these arrangements, it should modify its buses to match the new arrangements (asked by the host with IComponent::getInfo () or IAudioProcessor::getBusArrangement ()) and then return kResultTrue. If the Plug-in does not accept these arrangements, but can adapt its current arrangements (according to the wanted ones), it should modify its buses arrangements and return kResultFalse.
Implemented in AudioEffect, and SingleComponentEffect.
|
pure virtual |
Gets the bus arrangement for a given direction (input/output) and index.
Note: IComponent::getInfo () and IAudioProcessor::getBusArrangement () should be always return the same information about the buses arrangements.
Implemented in AudioEffect, and SingleComponentEffect.
Asks if a given sample size is supported see SymbolicSampleSizes.
Implemented in AudioEffect, and SingleComponentEffect.
|
pure virtual |
Gets the current Latency in samples.
The returned value defines the group delay or the latency of the Plug-in. For example, if the Plug-in internally needs to look in advance (like compressors) 512 samples then this Plug-in should report 512 as latency. If during the use of the Plug-in this latency change, the Plug-in has to inform the host by using IComponentHandler::restartComponent (kLatencyChanged), this could lead to audio playback interruption because the host has to recompute its internal mixer delay compensation. Note that for player live recording this latency should be zero or small.
Implemented in AudioEffect, and SingleComponentEffect.
|
pure virtual |
Called in disable state (setActive not called with true) before setProcessing is called and processing will begin.
Implemented in AudioEffect, and SingleComponentEffect.
Informs the Plug-in about the processing state.
This will be called before any process calls start with true and after with false. Note that setProcessing (false) may be called after setProcessing (true) without any process calls. In this call the Plug-in should do only light operation (no memory allocation or big setup reconfiguration), this could be used to reset some buffers (like Delay line or Reverb). The host has to be sure that it is called only when the Plug-in is enable (setActive was called)
Implemented in AudioEffect, and SingleComponentEffect.
|
pure virtual |
The Process call, where all information (parameter changes, event, audio buffer) are passed.
Implemented in AudioEffect, and SingleComponentEffect.
|
pure virtual |
Gets tail size in samples.
For example, if the Plug-in is a Reverb Plug-in and it knows that the maximum length of the Reverb is 2sec, then it has to return in getTailSamples() (in VST2 it was getGetTailSize ()): 2*sampleRate. This information could be used by host for offline processing, process optimization and downmix (avoiding signal cut (clicks)). It should return:
Implemented in AudioEffect, and SingleComponentEffect.
|
static |
