Steinberg::Vst::IAttributeList Class Reference

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

#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
	Sets integer value.
virtual tresult PLUGIN_API	getInt (AttrID id, int64 &value)=0
	Gets integer value.
virtual tresult PLUGIN_API	setFloat (AttrID id, double value)=0
	Sets float value.
virtual tresult PLUGIN_API	getFloat (AttrID id, double &value)=0
	Gets float value.
virtual tresult PLUGIN_API	setString (AttrID id, const TChar *string)=0
	Sets string value (UTF16) (must be null-terminated!).
virtual tresult PLUGIN_API	getString (AttrID id, TChar *string, uint32 sizeInBytes)=0
	Gets string value (UTF16).
virtual tresult PLUGIN_API	setBinary (AttrID id, const void *data, uint32 sizeInBytes)=0
	Sets binary data.
virtual tresult PLUGIN_API	getBinary (AttrID id, const void *&data, uint32 &sizeInBytes)=0
	Gets binary data.
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.
virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.
virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

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).

Definition at line 40 of file ivstattributes.h.

Member Typedef Documentation

AttrID

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

Definition at line 44 of file ivstattributes.h.

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) (must be null-terminated!).

Implemented in Steinberg::Vst::HostAttributeList.

Member Data Documentation

iid

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

static

Definition at line 71 of file ivstattributes.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/vst/ivstattributes.h