ags_vst_audio_effect.h File Reference

#include <glib.h>
#include <ags/vst3-capi/public.sdk/source/vst/ags_vst_bus.h>
#include <ags/vst3-capi/public.sdk/source/vst/ags_vst_component.h>
#include <ags/vst3-capi/pluginterfaces/vst/ags_vst_iaudio_processor.h>

Include dependency graph for ags_vst_audio_effect.h:

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

Go to the source code of this file.

Typedefs
typedef struct AgsVstAudioEffect	AudioEffect

Functions
AgsVstAudioEffect *	ags_vst_audio_effect_new ()
void	ags_vst_audio_effect_delete (AgsVstAudioEffect *audio_effect)
AgsVstAudioBus *	ags_vst_audio_effect_add_audio_input (AgsVstAudioEffect *audio_effect, AgsVstTChar *name, AgsVstSpeakerArrangement arr, AgsVstBusType bus_type, gint32 flags)
AgsVstAudioBus *	ags_vst_audio_effect_add_audio_output (AgsVstAudioEffect *audio_effect, AgsVstTChar *name, AgsVstSpeakerArrangement arr, AgsVstBusType bus_type, gint32 flags)
AgsVstAudioBus *	ags_vst_audio_effect_get_audio_input (AgsVstAudioEffect *audio_effect, gint32 index)
AgsVstAudioBus *	ags_vst_audio_effect_get_audio_output (AgsVstAudioEffect *audio_effect, gint32 index)
AgsVstEventBus *	ags_vst_audio_effect_add_event_input (AgsVstAudioEffect *audio_effect, AgsVstTChar *name, gint32 channels, AgsVstBusType bus_type, gint32 flags)
AgsVstEventBus *	ags_vst_audio_effect_add_event_output (AgsVstAudioEffect *audio_effect, AgsVstTChar *name, gint32 channels, AgsVstBusType bus_type, gint32 flags)
AgsVstEventBus *	ags_vst_audio_effect_get_event_input (AgsVstAudioEffect *audio_effect, gint32 index)
AgsVstEventBus *	ags_vst_audio_effect_get_event_output (AgsVstAudioEffect *audio_effect, gint32 index)
gint32	ags_vst_audio_effect_set_bus_arrangements (AgsVstAudioEffect *audio_effect, AgsVstSpeakerArrangement *inputs, gint32 num_ins, AgsVstSpeakerArrangement *outputs, gint32 num_outs)
gint32	ags_vst_audio_effect_get_bus_arrangement (AgsVstAudioEffect *audio_effect, AgsVstBusDirection bus_direction, gint32 bus_index, AgsVstSpeakerArrangement *arr)
gint32	ags_vst_audio_effect_can_process_sample_size (AgsVstAudioEffect *audio_effect, gint32 symbolic_sample_size)
guint32	ags_vst_audio_effect_get_latency_samples (AgsVstAudioEffect *audio_effect)
gint32	ags_vst_audio_effect_setup_processing (AgsVstAudioEffect *audio_effect, AgsVstProcessSetup *setup)
gint32	ags_vst_audio_effect_set_processing (AgsVstAudioEffect *audio_effect, gboolean state)
gint32	ags_vst_audio_effect_process (AgsVstAudioEffect *audio_effect, AgsVstProcessData *data)
guint32	ags_vst_audio_effect_get_tail_samples (AgsVstAudioEffect *audio_effect)

Typedef Documentation

AudioEffect

typedef struct AgsVstAudioEffect AudioEffect

Function Documentation

ags_vst_audio_effect_add_audio_input()

AgsVstAudioBus * ags_vst_audio_effect_add_audio_input	(	AgsVstAudioEffect *	audio_effect,
		AgsVstTChar *	name,
		AgsVstSpeakerArrangement	arr,
		AgsVstBusType	bus_type,
		gint32	flags
	)

Add audio input with name and arr of bus type using flags.

Parameters

audio_effect	the audio effect
name	the name
arr	the speaker arrangement
bus_type	the bus type as bus types
flags	the flags

Returns

the audio bus

Since

2.2.0

ags_vst_audio_effect_add_audio_output()

AgsVstAudioBus * ags_vst_audio_effect_add_audio_output	(	AgsVstAudioEffect *	audio_effect,
		AgsVstTChar *	name,
		AgsVstSpeakerArrangement	arr,
		AgsVstBusType	bus_type,
		gint32	flags
	)

Add audio output with name and arr of bus type using flags.

Parameters

audio_effect	the audio effect
name	the name as string
arr	the speaker arrangement
bus_type	the bus type
flags	the flags

Returns

the audio bus

Since

2.2.0

ags_vst_audio_effect_add_event_input()

AgsVstEventBus * ags_vst_audio_effect_add_event_input	(	AgsVstAudioEffect *	audio_effect,
		AgsVstTChar *	name,
		gint32	channels,
		AgsVstBusType	bus_type,
		gint32	flags
	)

Add event input with name and channels of bus type using flags.

Parameters

audio_effect	the audio effect
name	the name as string
channels	channels
bus_type	the bus type
flags	the flags

Returns

the event bus

Since

2.2.0

ags_vst_audio_effect_add_event_output()

AgsVstEventBus * ags_vst_audio_effect_add_event_output	(	AgsVstAudioEffect *	audio_effect,
		AgsVstTChar *	name,
		gint32	channels,
		AgsVstBusType	bus_type,
		gint32	flags
	)

Add event output with name and channels of bus type using flags.

Parameters

audio_effect	the audio effect
name	the name as string
channels	channels
bus_type	the bus type
flags	the flags

Returns

the event bus

Since

2.2.0

ags_vst_audio_effect_can_process_sample_size()

gint32 ags_vst_audio_effect_can_process_sample_size	(	AgsVstAudioEffect *	audio_effect,
		gint32	symbolic_sample_size
	)

Can audio effect process symbolic sample size.

Parameters

audio_effect	the audio effect
symbolic_sample_size	symbolic sample size

Returns

the result code

Since

2.2.0

ags_vst_audio_effect_delete()

void ags_vst_audio_effect_delete

(

AgsVstAudioEffect *

audio_effect

)

Delete.

Parameters

audio_effect

the audio effect

Since

2.2.0

ags_vst_audio_effect_get_audio_input()

AgsVstAudioBus * ags_vst_audio_effect_get_audio_input	(	AgsVstAudioEffect *	audio_effect,
		gint32	index
	)

Get audio input by index.

Parameters

audio_effect	the audio effect
index	the index to get

Returns

the audio bus

Since

2.2.0

ags_vst_audio_effect_get_audio_output()

AgsVstAudioBus * ags_vst_audio_effect_get_audio_output	(	AgsVstAudioEffect *	audio_effect,
		gint32	index
	)

Get audio output by index.

Parameters

audio_effect	the audio effect
index	the index to get

Returns

the audio bus

Since

2.2.0

ags_vst_audio_effect_get_bus_arrangement()

gint32 ags_vst_audio_effect_get_bus_arrangement	(	AgsVstAudioEffect *	audio_effect,
		AgsVstBusDirection	bus_direction,
		gint32	bus_index,
		AgsVstSpeakerArrangement *	arr
	)

Get bus arrangements of audio effect.

Parameters

audio_effect	the audio effect
bus_direction	the bus direction
bus_index	the bus index
arr	the speaker arrangement array

Returns

the result code

Since

2.2.0

ags_vst_audio_effect_get_event_input()

AgsVstEventBus * ags_vst_audio_effect_get_event_input	(	AgsVstAudioEffect *	audio_effect,
		gint32	index
	)

Get event input by index.

Parameters

audio_effect	the audio effect
index	the index to get

Returns

the event bus

Since

2.2.0

ags_vst_audio_effect_get_event_output()

AgsVstEventBus * ags_vst_audio_effect_get_event_output	(	AgsVstAudioEffect *	audio_effect,
		gint32	index
	)

Get event output by index.

Parameters

audio_effect	the audio effect
index	the index to get

Returns

the event bus

Since

2.2.0

ags_vst_audio_effect_get_latency_samples()

guint32 ags_vst_audio_effect_get_latency_samples

(

AgsVstAudioEffect *

audio_effect

)

Get lantency samples of audio effect.

Parameters

audio_effect

the audio effect

Returns

the latency

Since

2.2.0

ags_vst_audio_effect_get_tail_samples()

guint32 ags_vst_audio_effect_get_tail_samples

(

AgsVstAudioEffect *

audio_effect

)

Get tail samples of audio effect.

Parameters

audio_effect

the audio effect

Returns

the tail samples

Since

2.2.0

ags_vst_audio_effect_new()

AgsVstAudioEffect * ags_vst_audio_effect_new

(

)

Instantiate new Steinberg::Vst::AudioEffect the constructor as a C99 compatible handle a void pointer.

Returns

the AgsVstAudioEffect

Since

2.2.0

ags_vst_audio_effect_process()

gint32 ags_vst_audio_effect_process	(	AgsVstAudioEffect *	audio_effect,
		AgsVstProcessData *	data
	)

Process audio effect using data.

Parameters

audio_effect	the audio effect
data	the process data

Returns

the result code

Since

2.2.0

ags_vst_audio_effect_set_bus_arrangements()

gint32 ags_vst_audio_effect_set_bus_arrangements	(	AgsVstAudioEffect *	audio_effect,
		AgsVstSpeakerArrangement *	inputs,
		gint32	num_ins,
		AgsVstSpeakerArrangement *	outputs,
		gint32	num_outs
	)

Set bus arrangements of audio effect.

Parameters

audio_effect	the audio effect
inputs	the speaker arrangement
num_ins	number of inputs
outputs	the speaker arrangement array
num_outs	number of outputs

Returns

the result code

Since

2.2.0

ags_vst_audio_effect_set_processing()

gint32 ags_vst_audio_effect_set_processing	(	AgsVstAudioEffect *	audio_effect,
		gboolean	state
	)

Set processing of audio effect.

Parameters

audio_effect	the audio effect
state	true if processing, otherwise false

Returns

the result code

Since

2.2.0

ags_vst_audio_effect_setup_processing()

gint32 ags_vst_audio_effect_setup_processing	(	AgsVstAudioEffect *	audio_effect,
		AgsVstProcessSetup *	setup
	)

Setup processing of audio effect.

Parameters

audio_effect	the #AgsVstAudioEffect-struct pointer
setup	the process setup-struct pointer

Returns: the result code

Since: 2.2.0