ags_vst_ipersistent.h File Reference

#include <ags/vst3-capi/pluginterfaces/base/ags_vst_funknown.h>
#include <ags/vst3-capi/pluginterfaces/base/ags_vst_fvariant.h>

Include dependency graph for ags_vst_ipersistent.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AGS_VST_IPERSISTENT_IID   (ags_vst_ipersistent_get_iid())
#define	AGS_VST_IATTRIBUTES_IID   (ags_vst_iattributes_get_iid())
#define	AGS_VST_IATTRIBUTES2_IID   (ags_vst_iattributes2_get_iid())

Typedefs
typedef const AgsVstFIDString	AgsVstIAttrID
typedef struct IPersistent	AgsVstIPersistent
typedef struct IAttributes	AgsVstIAttributes
typedef struct IAttributes2	AgsVstIAttributes2

Functions
const AgsVstTUID *	ags_vst_ipersistent_get_iid ()
AgsVstTResult	ags_vst_ipersistent_load_attributes (AgsVstIPersistent *persistent, AgsVstIAttributes *attributes)
const AgsVstTUID *	ags_vst_iattributes_get_iid ()
AgsVstTResult	ags_vst_iattributes_set (AgsVstIAttributes *attr, AgsVstIAttrID attr_id, AgsVstFVariant *data)
AgsVstTResult	ags_vst_iattributes_queue (AgsVstIAttributes *attr, AgsVstIAttrID list_id, AgsVstFVariant *data)
AgsVstTResult	ags_vst_iattributes_set_binary_data (AgsVstIAttributes *attr, AgsVstIAttrID attr_id, void *data, guint32 bytes, gboolean copy_bytes)
AgsVstTResult	ags_vst_iattributes_get (AgsVstIAttributes *attr, AgsVstIAttrID attr_id, AgsVstFVariant *data)
AgsVstTResult	ags_vst_iattributes_unqueue (AgsVstIAttributes *attr, AgsVstIAttrID list_id, AgsVstFVariant *data)
gint32	ags_vst_iattributes_get_queue_item_count (AgsVstIAttributes *attr, AgsVstIAttrID attr_id)
AgsVstTResult	ags_vst_iattributes_reset_queue (AgsVstIAttributes *attr, AgsVstIAttrID attr_id)
AgsVstTResult	ags_vst_iattributes_reset_all_queues (AgsVstIAttributes *attr)
AgsVstTResult	ags_vst_iattributes_get_binary_data (AgsVstIAttributes *attr, AgsVstIAttrID attr_id, void *data, guint32 bytes)
guint32	ags_vst_iattributes_get_binary_data_size (AgsVstIAttributes *attr, AgsVstIAttrID attr_id)
const AgsVstTUID *	ags_vst_iattributes2_get_iid ()
gint32	ags_vst_iattributes2_count_attributes (AgsVstIAttributes2 *attr)
AgsVstIAttrID	ags_vst_iattributes2_get_attribute_id (AgsVstIAttributes2 *attr, gint32 index)

Macro Definition Documentation

AGS_VST_IATTRIBUTES2_IID

#define AGS_VST_IATTRIBUTES2_IID   (ags_vst_iattributes2_get_iid())

AGS_VST_IATTRIBUTES_IID

#define AGS_VST_IATTRIBUTES_IID   (ags_vst_iattributes_get_iid())

AGS_VST_IPERSISTENT_IID

#define AGS_VST_IPERSISTENT_IID   (ags_vst_ipersistent_get_iid())

Typedef Documentation

AgsVstIAttributes

typedef struct IAttributes AgsVstIAttributes

AgsVstIAttributes2

typedef struct IAttributes2 AgsVstIAttributes2

AgsVstIAttrID

typedef const AgsVstFIDString AgsVstIAttrID

AgsVstIPersistent

typedef struct IPersistent AgsVstIPersistent

Function Documentation

ags_vst_iattributes2_count_attributes()

gint32 ags_vst_iattributes2_count_attributes

(

AgsVstIAttributes2 *

attr

)

Count attributes.

Parameters

attr	the attributes

Returns

the count

Since

5.0.0

ags_vst_iattributes2_get_attribute_id()

AgsVstIAttrID ags_vst_iattributes2_get_attribute_id	(	AgsVstIAttributes2 *	attr,
		gint32	index
	)

Get IID.

Parameters

attr	the attributes
index	the index of attribute

Returns

the attribute identifier

Since

5.0.0

ags_vst_iattributes2_get_iid()

const AgsVstTUID * ags_vst_iattributes2_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_iattributes_get()

AgsVstTResult ags_vst_iattributes_get	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id,
		AgsVstFVariant *	data
	)

Get.

Parameters

attr	the attributes
attr_id	the attribute identifier
data	the data

Returns

the return code

Since

5.0.0

ags_vst_iattributes_get_binary_data()

AgsVstTResult ags_vst_iattributes_get_binary_data	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id,
		void *	data,
		guint32	bytes
	)

Get binary data.

Parameters

attr	the attributes
attr_id	the attribute identifier
data	the data
bytes	bytes

Returns

the return code

Since

5.0.0

ags_vst_iattributes_get_binary_data_size()

guint32 ags_vst_iattributes_get_binary_data_size	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id
	)

Get binary data size.

Parameters

attr	the attributes
attr_id	the attribute identifier

Returns

the size

Since

5.0.0

ags_vst_iattributes_get_iid()

const AgsVstTUID * ags_vst_iattributes_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_iattributes_get_queue_item_count()

gint32 ags_vst_iattributes_get_queue_item_count	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id
	)

Get item count.

Parameters

attr	the attributes
attr_id	the attribute identifier

Returns

the count

Since

5.0.0

ags_vst_iattributes_queue()

AgsVstTResult ags_vst_iattributes_queue	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	list_id,
		AgsVstFVariant *	data
	)

Queue.

Parameters

attr	the attributes
list_id	the attribute identifier
data	the data

Returns

the return code

Since

5.0.0

ags_vst_iattributes_reset_all_queues()

AgsVstTResult ags_vst_iattributes_reset_all_queues

(

AgsVstIAttributes *

attr

)

Reset all queues.

Parameters

attr	the attributes

Returns

the return code

Since

5.0.0

ags_vst_iattributes_reset_queue()

AgsVstTResult ags_vst_iattributes_reset_queue	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id
	)

Reset queue.

Parameters

attr	the attributes
attr_id	the attribute identifier

Returns

the return code

Since

5.0.0

ags_vst_iattributes_set()

AgsVstTResult ags_vst_iattributes_set	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id,
		AgsVstFVariant *	data
	)

Set.

Parameters

attr	the attributes
attr_id	the attribute identifier
data	the data

Returns

the return code

Since

5.0.0

ags_vst_iattributes_set_binary_data()

AgsVstTResult ags_vst_iattributes_set_binary_data	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	attr_id,
		void *	data,
		guint32	bytes,
		gboolean	copy_bytes
	)

Set binary data.

Parameters

attr	the attributes
attr_id	the attribute identifier
data	the data
bytes	bytes
copy_bytes	copy bytes

Returns

the return code

Since

5.0.0

ags_vst_iattributes_unqueue()

AgsVstTResult ags_vst_iattributes_unqueue	(	AgsVstIAttributes *	attr,
		AgsVstIAttrID	list_id,
		AgsVstFVariant *	data
	)

Unqueue.

Parameters

attr	the attributes
list_id	the attribute identifier
data	the data

Returns

the return code

Since

5.0.0

ags_vst_ipersistent_get_iid()

const AgsVstTUID * ags_vst_ipersistent_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_ipersistent_load_attributes()

AgsVstTResult ags_vst_ipersistent_load_attributes	(	AgsVstIPersistent *	persistent,
		AgsVstIAttributes *	attributes
	)

Load attributes.

Parameters

persistent	the persistent
attributes	the attributes

Since

5.0.0