BASS.NET API for the Un4seen BASS Audio LibraryBASS_VST_AEFFECT ClassBASS.NET API for the Un4seen BASS Audio Library
Basic VST Effect class as returned in the aeffect member of the BASS_VST_INFO class as obtained by BASS_VST_GetInfo(Int32, BASS_VST_INFO).

See the VST SDK for more informaton.

Inheritance Hierarchy

SystemObject
  Un4seen.Bass.AddOn.VstBASS_VST_AEFFECT

Namespace: Un4seen.Bass.AddOn.Vst
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.12.0
Syntax

[SerializableAttribute]
[StructLayoutAttribute(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
public sealed class BASS_VST_AEFFECT

The BASS_VST_AEFFECT type exposes the following members.

Constructors

  NameDescription
Public methodBASS_VST_AEFFECT
Default constructor.
Top
Methods

  NameDescription
Public methodStatic memberCode exampleFromIntPtr
Returns an instance of the BASS_VST_AEFFECT class derived from an IntPtr (aeffect) as obtained via BASS_VST_GetInfo(Int32, BASS_VST_INFO).
Public methodGetCurrentProgram
Returns the currently selected program number of the VST effect.
Public methodGetCurrentProgramName
Returns the currently selected program name of the VST effect.
Public methodCode exampleGetProgramName
Returns a specific program name of the VST effect.
Public methodCode exampleGetProgramNames
Returns an array of strings representing the available program names.
Public methodSetCurrentProgram
Sets the selected program number of the VST effect.
Public methodSetCurrentProgramName
Sets (overwrites) the current selected program name of the VST effect.
Public methodToString
Returns the description of this instance (In=x, Out=y).
(Overrides ObjectToString.)
Top
Fields

  NameDescription
Public fielddispatcher
Host to Plug-in dispatcher delegate method (see VST_AEFFECT_Dispatcher).
Public fieldflags
Effect flags (see BASSVSTAEffectFlags).
Public fieldfuture
Reserved for future use (please zero)
Public fieldgetParameter
Returns current value of automatable parameter (see VST_AEFFECT_GetParameter).
Public fieldinitialDelay
For algorithms which need input in the first place (group delay or latency). This value should be initialized in a resume state.
Public fieldioRatio
Input samplerate to output samplerate ratio, not used yet. Deprecated in VST 2.4!
Public fieldmagic
Must be kEffectMagic ('VstP')
Public fieldnumInputs
Number of audio inputs.
Public fieldnumOutputs
Number of audio outputs.
Public fieldnumParams
All programs are assumed to have numParams parameters.
Public fieldnumPrograms
Number of programs.
Public fieldobj
AudioEffect class pointer.
Public fieldoffQualities
Number of offline qualities (0: realtime only). Deprecated in VST 2.4!
Public fieldprocess
Accumulating process mode delegate method (deprecated in VST 2.4, use processReplacing instead - see VST_AEFFECT_Process).
Public fieldprocessDoubleReplacing
Process double-precision audio samples in replacing mode (see VST_AEFFECT_ProcessDoubleProc).
Public fieldprocessReplacing
Realtime process mode delegate method (see VST_AEFFECT_ProcessReplacing).
Public fieldrealQualities
Number of realtime qualities (0: realtime). Deprecated in VST 2.4!
Public fieldresvd1
Reserved for Host, must be 0.
Public fieldresvd2
Reserved for Host, must be 0.
Public fieldsetParameter
Set new value of automatable parameter (see VST_AEFFECT_SetParameter).
Public fielduniqueID
Registered unique identifier (register it at Steinberg 3rd party support Web). This is used to identify a plug-in during save+load of preset and project.
Public fielduser
User-defined pointer.
Public fieldversion
Plug-in version (example 0x1100 for version 1.1.0.0)
Top
Remarks

This class can only be used in the .Net Framework version 2.0 or above!

In order to retrieve an instance of this class you must first call BASS_VST_GetInfo(Int32, BASS_VST_INFO) and then pass the aeffect IntPtr to the static method FromIntPtr(IntPtr).

See Also

Reference