VST 3 Examples  VST 3.6.6
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
AGain Class Reference

#include <again.h>

+ Inheritance diagram for AGain:

Public Member Functions

 AGain ()
 
virtual ~AGain ()
 
tresult initialize (FUnknown *context)
 Called at first after constructor. More...
 
tresult terminate ()
 Called at the end before destructor. More...
 
tresult setActive (TBool state)
 Switch the Plug-in on/off. More...
 
tresult process (ProcessData &data)
 Here we go...the process call. More...
 
tresult receiveText (const char *text)
 Test of a communication channel between controller and component. More...
 
tresult setState (IBStream *state)
 For persistence. More...
 
tresult getState (IBStream *state)
 
tresult setupProcessing (ProcessSetup &newSetup)
 Will be called before any process call. More...
 
tresult setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts)
 Bus arrangement managing: in this example the 'again' will be mono for mono input/output and stereo for other arrangements. More...
 
tresult canProcessSampleSize (int32 symbolicSampleSize)
 Asks if a given sample size is supported see SymbolicSampleSizes. More...
 
tresult notify (IMessage *message)
 We want to receive message. More...
 
- Public Member Functions inherited from AudioEffect
 AudioEffect ()
 
AudioBusaddAudioInput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
AudioBusaddAudioOutput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
AudioBusgetAudioInput (int32 index)
 
AudioBusgetAudioOutput (int32 index)
 
EventBusaddEventInput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
EventBusaddEventOutput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 
EventBusgetEventInput (int32 index)
 
EventBusgetEventOutput (int32 index)
 
tresult getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement &arr)
 
uint32 getLatencySamples ()
 
tresult setProcessing (TBool state)
 
uint32 getTailSamples ()
 
 OBJ_METHODS (AudioEffect, Component) DEFINE_INTERFACES DEF_INTERFACE(IAudioProcessor) END_DEFINE_INTERFACES(Component) REFCOUNT_METHODS(Component) void **getChannelBuffersPointer(const AudioBusBuffers &bufs) const
 
uint32 getSampleFramesSizeInBytes (int32 numSamples)
 
 Component ()
 
void setControllerClass (const FUID &cid)
 
tresult removeAudioBusses ()
 
tresult removeEventBusses ()
 
tresult renameBus (MediaType type, BusDirection dir, int32 index, const String128 newName)
 
tresult getControllerClassId (TUID classID)
 
tresult setIoMode (IoMode mode)
 
int32 getBusCount (MediaType type, BusDirection dir)
 
tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info)
 
tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
 
tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
 
BusListgetBusList (MediaType type, BusDirection dir)
 
tresult removeAllBusses ()
 
 ComponentBase ()
 
virtual ~ComponentBase ()
 
FUnknowngetHostContext ()
 
IConnectionPointgetPeer ()
 
IMessageallocateMessage ()
 
tresult sendMessage (IMessage *message)
 
tresult sendTextMessage (const char8 *text)
 
tresult connect (IConnectionPoint *other)
 
tresult disconnect (IConnectionPoint *other)
 
- 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 Member Functions

static FUnknowncreateInstance (void *context)
 

Protected Member Functions

template<typename SampleType >
SampleType processAudio (SampleType **input, SampleType **output, int32 numChannels, int32 sampleFrames, float gain)
 

Protected Attributes

float fGain
 
float fGainReduction
 
float fVuPPMOld
 
int32 currentProcessMode
 
bool bHalfGain
 
bool bBypass
 
- Protected Attributes inherited from AudioEffect
ProcessSetup processSetup
 

Additional Inherited Members

- Data Fields inherited from AudioEffect
OBJ_METHODS(Component,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IComponent)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected BusList 
audioInputs
 
BusList audioOutputs
 
BusList eventInputs
 
BusList eventOutputs
 
OBJ_METHODS(ComponentBase,
FObject) DEFINE_INTERFACES
DEF_INTERFACE(IPluginBase)
DEF_INTERFACE(IConnectionPoint)
END_DEFINE_INTERFACES(FObject)
REFCOUNT_METHODS(FObject)
protected IConnectionPoint
peerConnection
 
- Static Public Attributes inherited from IPluginBase
static const FUID iid
 
- Static Public Attributes inherited from FUnknown
static const FUID iid
 
- Static Public Attributes inherited from IConnectionPoint
static const FUID iid
 
- Static Public Attributes inherited from IComponent
static const FUID iid
 
- Static Public Attributes inherited from IAudioProcessor
static const FUID iid
 

Constructor & Destructor Documentation

AGain ( )
~AGain ( )
virtual

Member Function Documentation

static FUnknown* createInstance ( void *  context)
inlinestatic
tresult initialize ( FUnknown context)
virtual

Called at first after constructor.

Reimplemented from AudioEffect.

Reimplemented in AGainWithSideChain.

tresult terminate ( )
virtual

Called at the end before destructor.

Reimplemented from AudioEffect.

tresult setActive ( TBool  state)
virtual

Switch the Plug-in on/off.

Reimplemented from AudioEffect.

tresult process ( ProcessData data)
virtual

Here we go...the process call.

Reimplemented from AudioEffect.

Reimplemented in AGainWithSideChain.

tresult receiveText ( const char text)
virtual

Test of a communication channel between controller and component.

Reimplemented from AudioEffect.

tresult setState ( IBStream state)
virtual

For persistence.

Reimplemented from AudioEffect.

tresult getState ( IBStream state)
virtual

Reimplemented from AudioEffect.

tresult setupProcessing ( ProcessSetup newSetup)
virtual

Will be called before any process call.

Reimplemented from AudioEffect.

tresult setBusArrangements ( SpeakerArrangement inputs,
int32  numIns,
SpeakerArrangement outputs,
int32  numOuts 
)
virtual

Bus arrangement managing: in this example the 'again' will be mono for mono input/output and stereo for other arrangements.

Reimplemented from AudioEffect.

Reimplemented in AGainWithSideChain.

tresult canProcessSampleSize ( int32  symbolicSampleSize)
virtual

Asks if a given sample size is supported see SymbolicSampleSizes.

Reimplemented from AudioEffect.

tresult notify ( IMessage message)
virtual

We want to receive message.

Reimplemented from AudioEffect.

SampleType processAudio ( SampleType **  input,
SampleType **  output,
int32  numChannels,
int32  sampleFrames,
float  gain 
)
protected

Field Documentation

float fGain
protected
float fGainReduction
protected
float fVuPPMOld
protected
int32 currentProcessMode
protected
bool bHalfGain
protected
bool bBypass
protected
Empty

Copyright ©2016 Steinberg Media Technologies GmbH. All Rights Reserved.