VST 3 Interfaces VST 3.7
SDK for developing VST plug-in
Steinberg Namespace Reference

Namespaces

namespace  FUnknownImpl
 
namespace  FUnknownPrivate
 
namespace  GeoConstants
 
namespace  KeyCodes
 
namespace  Linux
 
namespace  OneReaderOneWriter
 
namespace  U
 
namespace  Vst
 All VST specific interfaces are located in Vst namespace.
 

Classes

class  ConstStringTable
 
class  CPluginFactory
 
class  CPluginView
 
struct  FReleaser
 
class  FUID
 
class  FUnknown
 
class  FUnknownPtr
 
class  FVariant
 
class  IAttributes
 
class  IAttributes2
 
class  IBStream
 
class  ICloneable
 
class  IDependent
 
class  IErrorContext
 
class  IPersistent
 
class  IPlugFrame
 Callback interface passed to IPlugView.
 
class  IPluginBase
 
class  IPluginCompatibility
 
class  IPluginFactory
 
class  IPluginFactory2
 
class  IPluginFactory3
 
class  IPlugView
 Plug-in definition of a view.
 
class  IPlugViewContentScaleSupport
 Plug-in view content scale support.
 
class  IPtr
 
class  ISizeableStream
 
class  IString
 
class  IStringResult
 
class  ITest
 
class  ITestFactory
 Class factory that any testable module defines for creating tests that will be executed from the host. More...
 
class  ITestResult
 Test Result message logger [host imp] when a test is called, a pointer to an ITestResult is passed in, so the test class can output error messages. More...
 
class  ITestSuite
 A collection of tests supporting a hierarchical ordering [host imp] [create via hostclasses]. More...
 
class  IUpdateHandler
 
struct  KeyCode
 
class  MemoryStream
 
struct  ObjCClassBuilder
 
struct  ObjCInstance
 
struct  ObjCVariable
 
class  OPtr
 
struct  PClassInfo
 
struct  PClassInfo2
 
struct  PClassInfoW
 
struct  PFactoryInfo
 
class  ResizableMemoryIBStream
 
class  UString
 
class  UStringBuffer
 
struct  ViewRect
 Graphical rectangle structure.
 

Typedefs

typedef char int8
 
typedef uint8_t uint8
 
typedef unsigned char uchar
 
typedef int16_t int16
 
typedef uint16_t uint16
 
typedef int32_t int32
 
typedef uint32_t uint32
 
typedef int64_t int64
 
typedef uint64_t uint64
 
typedef int64 TSize
 
typedef int32 tresult
 
typedef uint64 TPtrInt
 
typedef uint8 TBool
 
typedef char char8
 
typedef char16_t char16
 
typedef char16 char
 
typedef const char8CStringA
 
typedef const char16CStringW
 
typedef const charCString
 
typedef const char8FIDString
 
typedef int32 UCoord
 
typedef int64 LARGE_INT
 
typedef char TUID[16]
 
typedef FIDString IAttrID
 
typedef uint32 ColorSpec
 
typedef uint8 ColorComponent
 
typedef ColorSpec UColorSpec
 
typedef ColorComponent UColorComponent
 
typedef UStringBuffer< 128 > UString128
 
typedef UStringBuffer< 256 > UString256
 

Enumerations

enum  Direction
 
enum  Orientation
 
enum  VirtualKeyCodes
 
enum  KeyModifier
 
enum  StandardColor
 

Functions

int32 _tstrlen (const T *wcs)
 
int32 tstrlen (const char *str)
 
int32 strlen8 (const char8 *str)
 
int32 strlen16 (const char16 *str)
 
int32 _tstrcmp (const T *src, const T *dst)
 
int32 tstrcmp (const char *src, const char *dst)
 
int32 strcmp8 (const char8 *src, const char8 *dst)
 
int32 strcmp16 (const char16 *src, const char16 *dst)
 
int32 strcmpT (const T *first, const T *last)
 
int32 strcmpT< char8 > (const char8 *first, const char8 *last)
 
int32 strcmpT< char16 > (const char16 *first, const char16 *last)
 
int32 _tstrncmp (const T *first, const T *last, uint32 count)
 
int32 tstrncmp (const char *first, const char *last, uint32 count)
 
int32 strncmp8 (const char8 *first, const char8 *last, uint32 count)
 
int32 strncmp16 (const char16 *first, const char16 *last, uint32 count)
 
int32 strncmpT (const T *first, const T *last, uint32 count)
 
int32 strncmpT< char8 > (const char8 *first, const char8 *last, uint32 count)
 
int32 strncmpT< char16 > (const char16 *first, const char16 *last, uint32 count)
 
T * _tstrcpy (T *dst, const T *src)
 
chartstrcpy (char *dst, const char *src)
 
char8strcpy8 (char8 *dst, const char8 *src)
 
char16strcpy16 (char16 *dst, const char16 *src)
 
T * _tstrncpy (T *dest, const T *source, uint32 count)
 
chartstrncpy (char *dest, const char *source, uint32 count)
 
char8strncpy8 (char8 *dest, const char8 *source, uint32 count)
 
char16strncpy16 (char16 *dest, const char16 *source, uint32 count)
 
T * _tstrcat (T *dst, const T *src)
 
chartstrcat (char *dst, const char *src)
 
char8strcat8 (char8 *dst, const char8 *src)
 
char16strcat16 (char16 *dst, const char16 *src)
 
void str8ToStr16 (char16 *dst, const char8 *src, int32 n=-1)
 
bool FIDStringsEqual (FIDString id1, FIDString id2)
 
bool strEmpty (const char *str)
 
bool str8Empty (const char8 *str)
 
bool str16Empty (const char16 *str)
 
const TUIDgetTUID ()
 
const T & Min (const T &a, const T &b)
 
const T & Max (const T &a, const T &b)
 
Abs (const T &value)
 
Sign (const T &value)
 
Bound (T minval, T maxval, T x)
 
void Swap (T &t1, T &t2)
 
bool IsApproximateEqual (T t1, T t2, T epsilon)
 
ToNormalized (const T &value, const int32 numSteps)
 
int32 FromNormalized (const T &norm, const int32 numSteps)
 
bool operator== (const FVariant &v1, const FVariant &v2)
 
bool operator!= (const FVariant &v1, const FVariant &v2)
 
SMTG_CONSTEXPR14 char VirtualKeyCodeToChar (uint8 vKey)
 
SMTG_CONSTEXPR14 uint8 CharToVirtualKeyCode (char character)
 
IPtr< I > owned (I *p)
 
IPtr< I > shared (I *p)
 
SMTG_CONSTEXPR ColorSpec MakeColorSpec (ColorComponent r, ColorComponent g, ColorComponent b)
 
SMTG_CONSTEXPR ColorSpec MakeColorSpec (ColorComponent r, ColorComponent g, ColorComponent b, ColorComponent a)
 
SMTG_CONSTEXPR ColorComponent GetBlue (ColorSpec cs)
 
SMTG_CONSTEXPR ColorComponent GetGreen (ColorSpec cs)
 
SMTG_CONSTEXPR ColorComponent GetRed (ColorSpec cs)
 
SMTG_CONSTEXPR ColorComponent GetAlpha (ColorSpec cs)
 
void SetBlue (ColorSpec &argb, ColorComponent b)
 
void SetGreen (ColorSpec &argb, ColorComponent g)
 
void SetRed (ColorSpec &argb, ColorComponent r)
 
void SetAlpha (ColorSpec &argb, ColorComponent a)
 
double NormalizeColorComponent (ColorComponent c)
 
ColorComponent DenormalizeColorComponent (double c)
 
void SetAlphaNorm (ColorSpec &argb, double a)
 
double GetAlphaNorm (ColorSpec cs)
 
double NormalizeAlpha (uint8 alpha)
 
ColorComponent DenormalizeAlpha (double alphaNorm)
 
ColorSpec StripAlpha (ColorSpec argb)
 
ColorSpec SMTG_CONSTEXPR BlendColor (ColorSpec color, double opacity)
 
void StringCopy (TDstChar *dst, int32 dstSize, const TSrcChar *src, int32 srcSize=-1)
 
int32 StringLength (const TSrcChar *src, int32 srcSize=-1)
 
 DEF_CLASS_IID (ITest) DEF_CLASS_IID(ITestSuite) DEF_CLASS_IID(ITestFactory) namespace Vst
 

Variables

 kNoInterface
 
 kResultOk
 
 kResultTrue
 
 kResultFalse
 
 kInvalidArgument
 
 kNotImplemented
 
 kInternalError
 
 kNotInitialized
 
 kOutOfMemory
 
 kNorth
 
 kNorthEast
 
 kEast
 
 kSouthEast
 
 kSouth
 
 kSouthWest
 
 kWest
 
 kNorthWest
 
 kNoDirection
 
 kNumberOfDirections
 
 kHorizontal
 
 kVertical
 
 kNumberOfOrientations
 
 KEY_BACK
 
 KEY_TAB
 
 KEY_CLEAR
 
 KEY_RETURN
 
 KEY_PAUSE
 
 KEY_ESCAPE
 
 KEY_SPACE
 
 KEY_NEXT
 
 KEY_END
 
 KEY_HOME
 
 KEY_LEFT
 
 KEY_UP
 
 KEY_RIGHT
 
 KEY_DOWN
 
 KEY_PAGEUP
 
 KEY_PAGEDOWN
 
 KEY_SELECT
 
 KEY_PRINT
 
 KEY_ENTER
 
 KEY_SNAPSHOT
 
 KEY_INSERT
 
 KEY_DELETE
 
 KEY_HELP
 
 KEY_NUMPAD0
 
 KEY_NUMPAD1
 
 KEY_NUMPAD2
 
 KEY_NUMPAD3
 
 KEY_NUMPAD4
 
 KEY_NUMPAD5
 
 KEY_NUMPAD6
 
 KEY_NUMPAD7
 
 KEY_NUMPAD8
 
 KEY_NUMPAD9
 
 KEY_MULTIPLY
 
 KEY_ADD
 
 KEY_SEPARATOR
 
 KEY_SUBTRACT
 
 KEY_DECIMAL
 
 KEY_DIVIDE
 
 KEY_F1
 
 KEY_F2
 
 KEY_F3
 
 KEY_F4
 
 KEY_F5
 
 KEY_F6
 
 KEY_F7
 
 KEY_F8
 
 KEY_F9
 
 KEY_F10
 
 KEY_F11
 
 KEY_F12
 
 KEY_NUMLOCK
 
 KEY_SCROLL
 
 KEY_SHIFT
 
 KEY_CONTROL
 
 KEY_ALT
 
 KEY_EQUALS
 
 KEY_CONTEXTMENU
 
 KEY_MEDIA_PLAY
 
 KEY_MEDIA_STOP
 
 KEY_MEDIA_PREV
 
 KEY_MEDIA_NEXT
 
 KEY_VOLUME_UP
 
 KEY_VOLUME_DOWN
 
 KEY_F13
 
 KEY_F14
 
 KEY_F15
 
 KEY_F16
 
 KEY_F17
 
 KEY_F18
 
 KEY_F19
 
 KEY_F20
 
 KEY_F21
 
 KEY_F22
 
 KEY_F23
 
 KEY_F24
 
 KEY_SUPER
 
 VKEY_FIRST_CODE
 
 VKEY_LAST_CODE
 
 VKEY_FIRST_ASCII
 
 kShiftKey
 
 kAlternateKey
 
 kCommandKey
 
 kControlKey
 
 kBlack
 
 kWhite
 
 kGray5
 
 kGray10
 
 kGray20
 
 kGray30
 
 kGray40
 
 kGray50
 
 kGray60
 
 kGray70
 
 kGray80
 
 kGray90
 
 kRed
 
 kLtRed
 
 kDkRed
 
 kGreen
 
 kLtGreen
 
 kDkGreen
 
 kBlue
 
 kLtBlue
 
 kDkBlue
 
 kMagenta
 
 kLtMagenta
 
 kDkMagenta
 
 kYellow
 
 kLtYellow
 
 kDkYellow
 
 kOrange
 
 kLtOrange
 
 kDkOrange
 
 kGold
 
 kBlack50
 
 kBlack70
 
 kNumStandardColors
 
 kLtGray
 
 kGray
 
 kDkGray
 
const FIDString kPlatformStringWin
 
const FIDString kPlatformStringMac
 
const FIDString kPlatformStringIOS
 
const FIDString kPlatformStringLinux
 
const FIDString kPlatformString
 
const FIDString kPlatformTypeHWND
 
const FIDString kPlatformTypeHIView
 
const FIDString kPlatformTypeNSView
 
const FIDString kPlatformTypeUIView
 
const FIDString kPlatformTypeX11EmbedWindowID
 
CPluginFactorygPluginFactory
 
const FIDString kPlatformTypeHWND = "HWND"
 The parent parameter in IPlugView::attached() is a HWND handle. More...
 
const FIDString kPlatformTypeHIView = "HIView"
 The parent parameter in IPlugView::attached() is a WindowRef. More...
 
const FIDString kPlatformTypeNSView = "NSView"
 The parent parameter in IPlugView::attached() is a NSView pointer. More...
 
const FIDString kPlatformTypeUIView = "UIView"
 The parent parameter in IPlugView::attached() is a UIView pointer. More...
 
const FIDString kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID"
 The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed. More...
 

Variable Documentation

◆ kPlatformTypeHWND

const FIDString kPlatformTypeHWND = "HWND"

The parent parameter in IPlugView::attached() is a HWND handle.

You should attach a child window to it. HWND handle. (Microsoft Windows)

◆ kPlatformTypeHIView

const FIDString kPlatformTypeHIView = "HIView"

The parent parameter in IPlugView::attached() is a WindowRef.

You should attach a HIViewRef to the content view of the window. HIViewRef. (Mac OS X)

◆ kPlatformTypeNSView

const FIDString kPlatformTypeNSView = "NSView"

The parent parameter in IPlugView::attached() is a NSView pointer.

You should attach a NSView to it. NSView pointer. (Mac OS X)

◆ kPlatformTypeUIView

const FIDString kPlatformTypeUIView = "UIView"

The parent parameter in IPlugView::attached() is a UIView pointer.

You should attach an UIView to it. UIView pointer. (iOS)

◆ kPlatformTypeX11EmbedWindowID

const FIDString kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID"

The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed.

You should attach a Window to it that supports the XEmbed extension. See https://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html X11 Window ID. (X11)

Empty

Copyright © Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.