ags_vst_icomponent.h File Reference

#include <glib.h>
#include <ags/vst3-capi/pluginterfaces/base/ags_vst_iplugin_base.h>
#include <ags/vst3-capi/pluginterfaces/base/ags_vst_ibstream.h>
#include <ags/vst3-capi/pluginterfaces/vst/ags_vst_types.h>

Include dependency graph for ags_vst_icomponent.h:

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

Go to the source code of this file.

Typedefs
typedef struct IComponent	AgsVstIComponent
typedef struct BusInfo	AgsVstBusInfo
typedef struct RoutingInfo	AgsVstRoutingInfo

Enumerations
enum	AgsVstMediaTypes { AGS_VST_KAUDIO = 0 , AGS_VST_KEVENT , AGS_VST_KNUM_MEDIA_TYPES }
enum	AgsVstBusDirections { AGS_VST_KINPUT = 0 , AGS_VST_KOUTPUT }
enum	AgsVstBusTypes { AGS_VST_KMAIN = 0 , AGS_VST_KAUX }
enum	AgsVstBusFlags { AGS_VST_KDEFAULT_ACTIVE = 1 , AGS_VST_KIS_CONTROL_VOLTAGE = 1 << 1 }
enum	AgsVstIoModes { AGS_VST_KSIMPLE = 0 , AGS_VST_KADVANCED , AGS_vST_KOFFLINE_PROCESSING }

Functions
const AgsVstTUID *	ags_vst_icomponent_get_iid ()
void	ags_vst_icomponent_destroy (AgsVstIComponent *icomponent)
AgsVstTResult	ags_vst_icomponent_get_controller_class_id (AgsVstIComponent *icomponent, AgsVstTUID *class_id)
AgsVstTResult	ags_vst_icomponent_set_io_mode (AgsVstIComponent *icomponent, guint io_mode)
gint32	ags_vst_icomponent_get_bus_count (AgsVstIComponent *icomponent, guint type, guint dir)
AgsVstTResult	ags_vst_icomponent_get_bus_info (AgsVstIComponent *icomponent, guint type, guint dir, gint32 index, AgsVstBusInfo *bus)
AgsVstTResult	ags_vst_icomponent_get_routing_info (AgsVstIComponent *icomponent, AgsVstRoutingInfo *in_info, AgsVstRoutingInfo *out_info)
AgsVstTResult	ags_vst_icomponent_activate_bus (AgsVstIComponent *icomponent, guint type, guint dir, gint32 index, gboolean state)
AgsVstTResult	ags_vst_icomponent_set_active (AgsVstIComponent *icomponent, gboolean state)
AgsVstTResult	ags_vst_icomponent_set_state (AgsVstIComponent *icomponent, AgsVstIBStream *state)
AgsVstTResult	ags_vst_icomponent_get_state (AgsVstIComponent *icomponent, AgsVstIBStream *state)

Variables
const gint32	ags_vst_kdefault_factory_flags

Typedef Documentation

AgsVstBusInfo

typedef struct BusInfo AgsVstBusInfo

AgsVstIComponent

typedef struct IComponent AgsVstIComponent

AgsVstRoutingInfo

typedef struct RoutingInfo AgsVstRoutingInfo

Enumeration Type Documentation

AgsVstBusDirections

enum AgsVstBusDirections

Enumerator
AGS_VST_KINPUT
AGS_VST_KOUTPUT

AgsVstBusFlags

enum AgsVstBusFlags

Enumerator
AGS_VST_KDEFAULT_ACTIVE
AGS_VST_KIS_CONTROL_VOLTAGE

AgsVstBusTypes

enum AgsVstBusTypes

Enumerator
AGS_VST_KMAIN
AGS_VST_KAUX

AgsVstIoModes

enum AgsVstIoModes

Enumerator
AGS_VST_KSIMPLE
AGS_VST_KADVANCED
AGS_vST_KOFFLINE_PROCESSING

AgsVstMediaTypes

enum AgsVstMediaTypes

Enumerator
AGS_VST_KAUDIO
AGS_VST_KEVENT
AGS_VST_KNUM_MEDIA_TYPES

Function Documentation

ags_vst_icomponent_activate_bus()

AgsVstTResult ags_vst_icomponent_activate_bus	(	AgsVstIComponent *	icomponent,
		guint	type,
		guint	dir,
		gint32	index,
		gboolean	state
	)

Activate bus.

Parameters

icomponent	the icomponent
type	the bus type
dir	the direction
index	the index
state	true if active, otherwise false

Returns

the return value

Since

5.0.0

ags_vst_icomponent_destroy()

void ags_vst_icomponent_destroy

(

AgsVstIComponent *

icomponent

)

Destroy.

Parameters

icomponent

the icomponent

Since

5.0.0

ags_vst_icomponent_get_bus_count()

gint32 ags_vst_icomponent_get_bus_count	(	AgsVstIComponent *	icomponent,
		guint	type,
		guint	dir
	)

Get bus count.

Parameters

icomponent	the icomponent
type	the bus type
dir	the direction

Returns

the bus count

Since

5.0.0

ags_vst_icomponent_get_bus_info()

AgsVstTResult ags_vst_icomponent_get_bus_info	(	AgsVstIComponent *	icomponent,
		guint	type,
		guint	dir,
		gint32	index,
		AgsVstBusInfo *	bus
	)

Get bus info.

Parameters

icomponent	the icomponent
type	the bus type
dir	the direction
index	the index
bus	the bus info

Returns

the return value

Since

5.0.0

ags_vst_icomponent_get_controller_class_id()

AgsVstTResult ags_vst_icomponent_get_controller_class_id	(	AgsVstIComponent *	icomponent,
		AgsVstTUID *	class_id
	)

Get controller class identifier.

Parameters

icomponent	the icomponent
class_id	the class identifier

Returns

the return value

Since

5.0.0

ags_vst_icomponent_get_iid()

const AgsVstTUID * ags_vst_icomponent_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstFUID

Since

5.0.0

ags_vst_icomponent_get_routing_info()

AgsVstTResult ags_vst_icomponent_get_routing_info	(	AgsVstIComponent *	icomponent,
		AgsVstRoutingInfo *	in_info,
		AgsVstRoutingInfo *	out_info
	)

Get routing info.

Parameters

icomponent	the icomponent
in_info	the input info
out_info	the output info

Returns

the return value

Since

5.0.0

ags_vst_icomponent_get_state()

AgsVstTResult ags_vst_icomponent_get_state	(	AgsVstIComponent *	icomponent,
		AgsVstIBStream *	state
	)

Get state.

Parameters

icomponent	the icomponent
state	the stream

Returns

the return value

Since

5.0.0

ags_vst_icomponent_set_active()

AgsVstTResult ags_vst_icomponent_set_active	(	AgsVstIComponent *	icomponent,
		gboolean	state
	)

Set active.

Parameters

icomponent	the icomponent
state	true if active, otherwise false

Returns

the return value

Since

5.0.0

ags_vst_icomponent_set_io_mode()

AgsVstTResult ags_vst_icomponent_set_io_mode	(	AgsVstIComponent *	icomponent,
		guint	io_mode
	)

Set input/output mode.

Parameters

icomponent	the icomponent
io_mode	the IO mode

Returns

the return value

Since

5.0.0

ags_vst_icomponent_set_state()

AgsVstTResult ags_vst_icomponent_set_state	(	AgsVstIComponent *	icomponent,
		AgsVstIBStream *	state
	)

Set state.

Parameters

icomponent	the icomponent
state	the stream

Returns

the return value

Since

5.0.0

Variable Documentation

ags_vst_kdefault_factory_flags

const gint32 ags_vst_kdefault_factory_flags

extern