Class ALVSTHost.TALVSTHost

Revision as of 00:17, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 02:45, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 02:45, 11 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: AudioLabPkg

Unit: ALVSTHost

Inherits: TALVSTBasicHost

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 4.2 Public 5 Methods 5.1 Public 6 Events 7 From TALVSTBasicHost 8 Properties 8.1 Published 9 PinLists 10 From TALBasicMultiInput 11 Properties 11.1 Published

Syntax

Delphi:

type TALVSTHost = class( TALVSTBasicHost )

C++ Builder:

class TALVSTHost : public TALVSTBasicHost

Visual C++ (MFC):

class CTALVSTHost : public CTALVSTBasicHost

C# (.NET):

public ref class TALVSTHost : Mitov.AudioLab.VSTBasicHost

Summary

VST 2.X PlugIn host component.

Description

Use this component to host VST 2.X PlugIns.

Diagram:

Properties

Published

• FileName - Specifies the file name of the VST PlugIn DLL.
• HostVstVersion - Specifies the highest VST version supported by the host.
• HostLanguage - Specifies the language of the host.
• PanLawType - Specifies the Panning Law used by the Host.
• Parameters - Specifies the parameter values of the VST PlugIn.
• ParameterQuantization - Specifies the parameter quantization.
• HostTempo - Specifies the host tempo.
• NumberAutomatable - Specifies the number of automatable parameters.
• AutoIdle - Specifies if the component will automatically handle Idle requests from the VST PlugIn.
• PlugInDir - Specifies the VST PlugIn directory.
• Bypass - Specifies if the VST PlugIn sill be bypassed.
• CurrentProgram - Specifies the current program.
• HostSuports - Specifies the features supported by the VST host component.

Public

• UniqueID - Returns the unique ID of the VST PlugIn.
• TailSize - Return after what time the response to an input sample will have die to zero.
• PlugInSuports - Returns the features supported by the VST PlugIn.
• Category - Returns the VST effect category.
• VendorVersion - Returns the VST DLL vendor-specific version.
• VuValue - Returns the Volume Units of the VST PlugIn.
• EffectName - Returns the VST effect name.
• ProductName - Returns the VST DLL product name.
• Version - Returns the VST DLL vendor-specific version.
• VstVersion - Returns the maximal supported VST version by the VST DLL .
• Opened - Indicates if the VST PlugIn is opened.
• Outputs - List of VST PlugIn output pins.
• Inputs - List of VST PlugIn input pins.
• Editor - Access to the editor properties, and methods.
• VendorName - Returns the VST DLL vendor name.

Methods

Public

• procedure Close() - Closes and unloads the VST PlugIn.
• function Open() : Boolean - Loads and opens the VST PlugIn.
• procedure SavePreset(AFileName : String) - Saves the VST PlugIn presets to a file.
• procedure SavePreset(AStream : TStream) - Saves the VST PlugIn presets to a stream.
• procedure LoadPreset(AFileName : String) - Loads the VST PlugIn presets from a file.
• procedure LoadPreset(AStream : TStream) - Loads the VST PlugIn presets from a stream.
• procedure SaveBank(AFileName : String) - Saves the VST PlugIn banks to a file.
• procedure SaveBank(AStream : TStream) - Saves the VST PlugIn banks to a stream.
• procedure LoadBank(AFileName : String) - Loads the VST PlugIn banks from a file.
• procedure LoadBank(AStream : TStream) - Loads the VST PlugIn banks from a stream.
• procedure Idle() - Provides the PlugIn with the requested Idle.
• function PlugInDispatch(opCode : Integer; Index : Integer; value : Integer; pntr : pointer; opt : double) : Integer - allows issuing direct low level VST PlugIn commands.

Events

• OnError - Occurs on PlugIn error.
• OnIONumberChanged - The number of inputs/outputs has changed.
• OnLoaded - The VST PlugIn has been loaded.
• OnNeedIdle - The VST PlugIn needs Idle.
• OnUpdateDisplay - The display needs to be updated(Some parameter has changed.)
• OnBeginEdit - Tells the host that if it needs to, it has to record automation data for this control.
• OnEndEdit - Notifies the host that this control is no more moved by the mouse.

From TALVSTBasicHost

Properties

Published

• Enabled - Enables/Disables the VST PlugIn.
• Precision - Specifies the floating-point precision used for processing (32 or 64 bit).

PinLists

• InputPins - The audio input pins of the VST Host filter.
• OutputPins - The audio output pins of the VST Host filter.

From TALBasicMultiInput

Properties

Published

• Threading - Specifies the desired threading settings for the filtering.