IAttributeList Class Reference
[VST 3 Interfaces to be implemented by HostVST 3 Interfaces defined in version 3.0.0]

Attribute list used in IMessage and IStreamAttributes. More...

#include <ivstattributes.h>

Inheritance diagram for IAttributeList:
Inheritance graph
[legend]

Public Types

typedef const charAttrID

Public Member Functions

virtual tresult setInt (AttrID id, int64 value)=0
 Sets integer value.
virtual tresult getInt (AttrID id, int64 &value)=0
 Gets integer value.
virtual tresult setFloat (AttrID id, double value)=0
 Sets float value.
virtual tresult getFloat (AttrID id, double &value)=0
 Gets float value.
virtual tresult setString (AttrID id, const TChar *string)=0
 Sets string value (UTF16).
virtual tresult getString (AttrID id, TChar *string, uint32 size)=0
 Gets string value (UTF16).
virtual tresult setBinary (AttrID id, const void *data, uint32 size)=0
 Sets binary data.
virtual tresult getBinary (AttrID id, const void *&data, uint32 &size)=0
 Gets binary data.

Static Public Attributes

static const FUID iid

Detailed Description

Attribute list used in IMessage and IStreamAttributes.

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


Member Typedef Documentation

typedef const char* AttrID

Member Function Documentation

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

Sets integer value.

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

Gets integer value.

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

Sets float value.

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

Gets float value.

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

Sets string value (UTF16).

virtual tresult getString ( AttrID  id,
TChar string,
uint32  size 
) [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)!)

virtual tresult setBinary ( AttrID  id,
const void *  data,
uint32  size 
) [pure virtual]

Sets binary data.

virtual tresult getBinary ( AttrID  id,
const void *&  data,
uint32 size 
) [pure virtual]

Gets binary data.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.