Steinberg::Vst::IAttributeList Class Reference

#include <ivstattributes.h>

Inheritance diagram for Steinberg::Vst::IAttributeList:

Public Types
typedef const char *	AttrID

Public Member Functions
virtual tresult PLUGIN_API	setInt (AttrID id, int64 value)=0
virtual tresult PLUGIN_API	getInt (AttrID id, int64 &value)=0
virtual tresult PLUGIN_API	setFloat (AttrID id, double value)=0
virtual tresult PLUGIN_API	getFloat (AttrID id, double &value)=0
virtual tresult PLUGIN_API	setString (AttrID id, const TChar *string)=0
virtual tresult PLUGIN_API	getString (AttrID id, TChar *string, uint32 sizeInBytes)=0
virtual tresult PLUGIN_API	setBinary (AttrID id, const void *data, uint32 sizeInBytes)=0
virtual tresult PLUGIN_API	getBinary (AttrID id, const void *&data, uint32 &sizeInBytes)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::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 presetAttributes).

Member Typedef Documentation

AttrID

typedef const char* Steinberg::Vst::IAttributeList::AttrID

Member Function Documentation

getBinary()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::getBinary ( AttrID id, const void *& data, uint32 & sizeInBytes )

pure virtual

Gets binary data.

Implemented in Steinberg::Vst::HostAttributeList.

getFloat()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::getFloat ( AttrID id, double & value )

pure virtual

Gets float value.

Implemented in Steinberg::Vst::HostAttributeList.

getInt()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::getInt ( AttrID id, int64 & value )

pure virtual

Gets integer value.

Implemented in Steinberg::Vst::HostAttributeList.

getString()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::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 Steinberg::Vst::HostAttributeList.

setBinary()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::setBinary ( AttrID id, const void * data, uint32 sizeInBytes )

pure virtual

Sets binary data.

Implemented in Steinberg::Vst::HostAttributeList.

setFloat()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::setFloat ( AttrID id, double value )

pure virtual

Sets float value.

Implemented in Steinberg::Vst::HostAttributeList.

setInt()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::setInt ( AttrID id, int64 value )

pure virtual

Sets integer value.

Implemented in Steinberg::Vst::HostAttributeList.

setString()

virtual tresult PLUGIN_API Steinberg::Vst::IAttributeList::setString ( AttrID id, const TChar * string )

pure virtual

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

Implemented in Steinberg::Vst::HostAttributeList.

Member Data Documentation

iid

const FUID Steinberg::Vst::IAttributeList::iid

static

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstattributes.h