VST 3 Interfaces VST 3.7
SDK for developing VST plug-in
IAttributeList Class Referenceabstract

Attribute list used in IMessage and IStreamAttributes: Vst::IAttributeList. More...

#include <ivstattributes.h>

+ Inheritance diagram for IAttributeList:

Public Types

typedef const charAttrID
 

Public Member Functions

virtual tresult setInt (AttrID id, int64 value)=0
 Sets integer value. More...
 
virtual tresult getInt (AttrID id, int64 &value)=0
 Gets integer value. More...
 
virtual tresult setFloat (AttrID id, double value)=0
 Sets float value. More...
 
virtual tresult getFloat (AttrID id, double &value)=0
 Gets float value. More...
 
virtual tresult setString (AttrID id, const TChar *string)=0
 Sets string value (UTF16) (must be null-terminated!). More...
 
virtual tresult getString (AttrID id, TChar *string, uint32 sizeInBytes)=0
 Gets string value (UTF16). More...
 
virtual tresult setBinary (AttrID id, const void *data, uint32 sizeInBytes)=0
 Sets binary data. More...
 
virtual tresult getBinary (AttrID id, const void *&data, uint32 &sizeInBytes)=0
 Gets binary data. 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
 

Detailed Description

Attribute list used in IMessage and IStreamAttributes: Vst::IAttributeList.

  • [host imp]
  • [released: 3.0.0]
  • [mandatory]

An attribute list associates values with a key (id: some predefined keys can be found in Predefined Preset Attributes).

Member Typedef Documentation

◆ AttrID

typedef const char* AttrID

Member Function Documentation

◆ setInt()

virtual tresult setInt ( AttrID  id,
int64  value 
)
pure virtual

Sets integer value.

Implemented in HostAttributeList.

◆ getInt()

virtual tresult getInt ( AttrID  id,
int64 value 
)
pure virtual

Gets integer value.

Implemented in HostAttributeList.

◆ setFloat()

virtual tresult setFloat ( AttrID  id,
double  value 
)
pure virtual

Sets float value.

Implemented in HostAttributeList.

◆ getFloat()

virtual tresult getFloat ( AttrID  id,
double &  value 
)
pure virtual

Gets float value.

Implemented in HostAttributeList.

◆ setString()

virtual tresult setString ( AttrID  id,
const TChar string 
)
pure virtual

Sets string value (UTF16) (must be null-terminated!).

Implemented in HostAttributeList.

◆ getString()

virtual tresult getString ( AttrID  id,
TChar string,
uint32  sizeInBytes 
)
pure virtual

Gets string value (UTF16).

Note that Size is in Byte, not the string Length! Do not forget to multiply the length by sizeof (TChar)!

Implemented in HostAttributeList.

◆ setBinary()

virtual tresult setBinary ( AttrID  id,
const void *  data,
uint32  sizeInBytes 
)
pure virtual

Sets binary data.

Implemented in HostAttributeList.

◆ getBinary()

virtual tresult getBinary ( AttrID  id,
const void *&  data,
uint32 sizeInBytes 
)
pure virtual

Gets binary data.

Implemented in HostAttributeList.

Member Data Documentation

◆ iid

const FUID iid
static
Empty

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