#include <ags/vst3-capi/base/source/ags_vst_fobject.h>
#include <ags/vst3-capi/pluginterfaces/vst/ags_vst_iedit_controller.h>
#include <ags/vst3-capi/pluginterfaces/vst/ags_vst_iunits.h>

Include dependency graph for ags_vst_parameters.h:

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

Go to the source code of this file.

Typedefs
typedef struct AgsVstParameter	Parameter

typedef struct AgsVstRangeParameter	RangeParameter

typedef struct AgsVstStringListParameter	StringListParameter

typedef struct AgsVstParameterContainer	ParameterContainer

Functions
AgsVstParameter *	ags_vst_parameter_new ()

AgsVstParameter *	ags_vst_parameter_new_with_info (AgsVstParameterInfo *info)

AgsVstParameter *	ags_vst_parameter_new_full (gunichar2 title, guint32 tag, gunichar2 units, gdouble default_value_normalized, gint32 step_count, gint32 flags, gint32 unit_id, gunichar2 *short_title)

void	ags_vst_parameter_delete (AgsVstParameter *parameter)

AgsVstParameterInfo *	ags_vst_parameter_get_info (AgsVstParameter *parameter)

void	ags_vst_parameter_set_unit_id (AgsVstParameter *parameter, gint32 id)

gint32	ags_vst_parameter_get_unit_id (AgsVstParameter *parameter)

gdouble	ags_vst_parameter_get_normalized (AgsVstParameter *parameter)

gboolean	ags_vst_parameter_set_normalized (AgsVstParameter *parameter, gdouble v)

void	ags_vst_parameter_to_string (AgsVstParameter *parameter, gdouble value_normalized, AgsVstString128 string)

gboolean	ags_vst_parameter_from_string (AgsVstParameter parameter, gunichar2 string, gdouble *value_normalized)

gdouble	ags_vst_parameter_to_plain (AgsVstParameter *parameter, gdouble value_normalized)

gdouble	ags_vst_parameter_to_normalized (AgsVstParameter *parameter, gdouble plain_value)

gint32	ags_vst_parameter_get_precision (AgsVstParameter *parameter)

void	ags_vst_parameter_set_precision (AgsVstParameter *parameter, gint32 val)

AgsVstRangeParameter *	ags_vst_range_parameter_new_with_info (AgsVstParameterInfo *param_info, gdouble min, gdouble max)

AgsVstRangeParameter *	ags_vst_range_parameter_new_full (gunichar2 title, guint32 tag, gunichar2 units, gdouble min_plain, gdouble max_plain, gdouble default_value_plain, gint32 step_count, gint32 flags, gint32 unit_id, gunichar2 *short_title)

gdouble	ags_vst_range_parameter_get_min (AgsVstRangeParameter *range_parameter)

void	ags_vst_range_parameter_set_min (AgsVstRangeParameter *range_parameter, gdouble value)

gdouble	ags_vst_range_parameter_get_max (AgsVstRangeParameter *range_parameter)

void	ags_vst_range_parameter_set_max (AgsVstRangeParameter *range_parameter, gdouble value)

void	ags_vst_range_parameter_to_string (AgsVstRangeParameter *range_parameter, gdouble value_normalized, AgsVstString128 string)

gboolean	ags_vst_range_parameter_from_string (AgsVstRangeParameter range_parameter, gunichar2 string, gdouble *value_normalized)

gdouble	ags_vst_range_parameter_to_plain (AgsVstRangeParameter *range_parameter, gdouble value_normalized)

gdouble	ags_vst_range_parameter_to_normalized (AgsVstRangeParameter *range_parameter, gdouble plain_value)

AgsVstStringListParameter *	ags_vst_string_list_parameter_new_with_info (AgsVstParameterInfo *param_info)

AgsVstStringListParameter *	ags_vst_string_list_parameter_new_full (gunichar2 title, guint32 tag, gunichar2 units, gint32 flags, gint32 unit_id, gunichar2 *short_title)

void	ags_vst_string_list_parameter_append_string (AgsVstStringListParameter *string_list_parameter, AgsVstString128 string)

gboolean	ags_vst_string_list_parameter_replace_string (AgsVstStringListParameter *string_list_parameter, gint32 index, AgsVstString128 string)

void	ags_vst_string_list_parameter_to_string (AgsVstStringListParameter *string_list_parameter, gdouble value_normalized, AgsVstString128 string)

gboolean	ags_vst_string_list_parameter_from_string (AgsVstStringListParameter string_list_parameter, gunichar2 string, gdouble *_value_normalized)

gdouble	ags_vst_string_list_parameter_to_plain (AgsVstStringListParameter *string_list_parameter, gdouble value_normalized)

gdouble	ags_vst_string_list_parameter_to_normalized (AgsVstStringListParameter *string_list_parameter, gdouble plain_value)

AgsVstParameterContainer *	ags_vst_parameter_container_new ()

void	ags_vst_parameter_container_init (AgsVstParameterContainer *parameter_container, gint32 initial_size, gint32 resize_delta)

AgsVstParameter *	ags_vst_parameter_container_add_parameter_with_info (AgsVstParameterContainer parameter_container, AgsVstParameterInfo info)

AgsVstParameter *	ags_vst_parameter_container_add_parameter_extended (AgsVstParameterContainer parameter_container, gunichar2 title, gunichar2 units, gint32 step_count, gdouble default_value_normalized, gint32 flags, gint32 tag, gint32 unit_id, gunichar2 short_title)

AgsVstParameter *	ags_vst_parameter_container_add_parameter (AgsVstParameterContainer parameter_container, AgsVstParameter p)

gint32	ags_vst_parameter_container_get_parameter_count (AgsVstParameterContainer *parameter_container)

AgsVstParameter *	ags_vst_parameter_container_get_parameter_by_index (AgsVstParameterContainer *parameter_container, gint32 index)

void	ags_vst_parameter_container_remove_all (AgsVstParameterContainer *parameter_container)

AgsVstParameter *	ags_vst_parameter_container_get_parameter (AgsVstParameterContainer *parameter_container, guint32 tag)

Typedef Documentation

◆ Parameter

typedef struct AgsVstParameter Parameter

◆ ParameterContainer

typedef struct AgsVstParameterContainer ParameterContainer

◆ RangeParameter

typedef struct AgsVstRangeParameter RangeParameter

◆ StringListParameter

typedef struct AgsVstStringListParameter StringListParameter

Function Documentation

◆ ags_vst_parameter_container_add_parameter()

AgsVstParameter * ags_vst_parameter_container_add_parameter	(	AgsVstParameterContainer *	parameter_container,
		AgsVstParameter *	p
	)

Add parameter.

Parameters

parameter_container	the parameter container
p	the parameter

Returns: the parameter

Since: 5.0.0

◆ ags_vst_parameter_container_add_parameter_extended()

AgsVstParameter * ags_vst_parameter_container_add_parameter_extended	(	AgsVstParameterContainer *	parameter_container,
		gunichar2 *	title,
		gunichar2 *	units,
		gint32	step_count,
		gdouble	default_value_normalized,
		gint32	flags,
		gint32	tag,
		gint32	unit_id,
		gunichar2 *	short_title
	)

Add parameter extended.

Parameters

parameter_container	the parameter container
title	the title
units	the units
step_count	the step count
default_value_normalized	the default normalized value
flags	the flags
tag	the tag
unit_id	the unit identifier
short_title	the short title

Returns: the parameter

Since: 5.0.0

◆ ags_vst_parameter_container_add_parameter_with_info()

AgsVstParameter * ags_vst_parameter_container_add_parameter_with_info	(	AgsVstParameterContainer *	parameter_container,
		AgsVstParameterInfo *	info
	)

Add parameter with info.

Parameters

parameter_container	the parameter container
info	the parameter info

Returns: the parameter

Since: 5.0.0

◆ ags_vst_parameter_container_get_parameter()

AgsVstParameter * ags_vst_parameter_container_get_parameter	(	AgsVstParameterContainer *	parameter_container,
		guint32	tag
	)

Get parameter.

Parameters

parameter_container	the parameter container
tag	the tag

Since: 5.0.0

◆ ags_vst_parameter_container_get_parameter_by_index()

AgsVstParameter * ags_vst_parameter_container_get_parameter_by_index	(	AgsVstParameterContainer *	parameter_container,
		gint32	index
	)

Get parameter by index.

Parameters

parameter_container	the parameter container
index	the index

Returns: the parameter

Since: 5.0.0

◆ ags_vst_parameter_container_get_parameter_count()

gint32 ags_vst_parameter_container_get_parameter_count ( AgsVstParameterContainer * parameter_container )

Get parameter count.

Parameters

parameter_container the parameter container

Returns: the parameter count

Since: 5.0.0

◆ ags_vst_parameter_container_init()

void ags_vst_parameter_container_init	(	AgsVstParameterContainer *	parameter_container,
		gint32	initial_size,
		gint32	resize_delta
	)

Init.

Parameters

parameter_container	the parameter container
initial_size	the initial size
resize_delta	the resize delta

Since: 5.0.0

◆ ags_vst_parameter_container_new()

AgsVstParameterContainer * ags_vst_parameter_container_new ( )

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

Returns: the AgsVstParameterContainer

Since: 5.0.0

◆ ags_vst_parameter_container_remove_all()

void ags_vst_parameter_container_remove_all ( AgsVstParameterContainer * parameter_container )

Remove all.

Parameters

parameter_container the parameter container

Since: 5.0.0

◆ ags_vst_parameter_delete()

void ags_vst_parameter_delete ( AgsVstParameter * parameter )

Delete.

Parameters

parameter the parameters

Since: 5.0.0

◆ ags_vst_parameter_from_string()

gboolean ags_vst_parameter_from_string	(	AgsVstParameter *	parameter,
		gunichar2 *	string,
		gdouble *	value_normalized
	)

From string.

Parameters

parameter	the parameter
string	the string
value_normalized	the normalized value

Returns: true if success, otherwise false

Since: 5.0.0

◆ ags_vst_parameter_get_info()

AgsVstParameterInfo * ags_vst_parameter_get_info ( AgsVstParameter * parameter )

Get info.

Parameters

parameter the parameter

Returns: the parameter info

Since: 5.0.0

◆ ags_vst_parameter_get_normalized()

gdouble ags_vst_parameter_get_normalized ( AgsVstParameter * parameter )

Get normalized.

Parameters

parameter the parameter

Returns: the normalized value

Since: 5.0.0

◆ ags_vst_parameter_get_precision()

gint32 ags_vst_parameter_get_precision ( AgsVstParameter * parameter )

Get precision.

Parameters

parameter the parameter

Returns: the precision

Since: 5.0.0

◆ ags_vst_parameter_get_unit_id()

gint32 ags_vst_parameter_get_unit_id ( AgsVstParameter * parameter )

Get unit identifier.

Parameters

parameter the parameter

Returns: the unit identifier

Since: 5.0.0

◆ ags_vst_parameter_new()

AgsVstParameter * ags_vst_parameter_new ( )

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

Returns: the AgsVstParameter

Since: 5.0.0

◆ ags_vst_parameter_new_full()

AgsVstParameter * ags_vst_parameter_new_full	(	gunichar2 *	title,
		guint32	tag,
		gunichar2 *	units,
		gdouble	default_value_normalized,
		gint32	step_count,
		gint32	flags,
		gint32	unit_id,
		gunichar2 *	short_title
	)

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

Parameters

title	the title
tag	the tag
units	the units
default_value_normalized	default value normalized
step_count	the step count
flags	the flags
unit_id	the unit identifier
short_title	the short title

Returns: the AgsVstParameter

Since: 5.0.0

◆ ags_vst_parameter_new_with_info()

AgsVstParameter * ags_vst_parameter_new_with_info ( AgsVstParameterInfo * info )

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

Parameters

info	the parameter info

Returns: the AgsVstParameter

Since: 5.0.0

◆ ags_vst_parameter_set_normalized()

gboolean ags_vst_parameter_set_normalized	(	AgsVstParameter *	parameter,
		gdouble	v
	)

Set normalized.

Parameters

parameter	the parameter
v	the normalized value

Returns: true if success, otherwise false

Since: 5.0.0

◆ ags_vst_parameter_set_precision()

void ags_vst_parameter_set_precision	(	AgsVstParameter *	parameter,
		gint32	val
	)

Set precision.

Parameters

parameter	the parameter
val	the precision

Since: 5.0.0

◆ ags_vst_parameter_set_unit_id()

void ags_vst_parameter_set_unit_id	(	AgsVstParameter *	parameter,
		gint32	id
	)

Set unit identifier.

Parameters

parameter	the parameter
id	the identifier

Since: 5.0.0

◆ ags_vst_parameter_to_normalized()

gdouble ags_vst_parameter_to_normalized	(	AgsVstParameter *	parameter,
		gdouble	plain_value
	)

To normalized.

Parameters

parameter	the parameter
plain_value	the plain value

Returns: the normalized value

Since: 5.0.0

◆ ags_vst_parameter_to_plain()

gdouble ags_vst_parameter_to_plain	(	AgsVstParameter *	parameter,
		gdouble	value_normalized
	)

To plain.

Parameters

parameter	the parameter
value_normalized	the normalized value

Returns: the plain value

Since: 5.0.0

◆ ags_vst_parameter_to_string()

void ags_vst_parameter_to_string	(	AgsVstParameter *	parameter,
		gdouble	value_normalized,
		AgsVstString128	string
	)

To string.

Parameters

parameter	the parameter
value_normalized	the normalized value
string	the string

Since: 5.0.0

◆ ags_vst_range_parameter_from_string()

gboolean ags_vst_range_parameter_from_string	(	AgsVstRangeParameter *	range_parameter,
		gunichar2 *	string,
		gdouble *	value_normalized
	)

From string.

Parameters

range_parameter	the range parameter
string	the string
value_normalized	the normalized value

Returns: true if success, otherwise false

Since: 5.0.0

◆ ags_vst_range_parameter_get_max()

gdouble ags_vst_range_parameter_get_max ( AgsVstRangeParameter * range_parameter )

Get maximum.

@range_parameter the range parameter

Returns: the maximum

Since: 5.0.0

◆ ags_vst_range_parameter_get_min()

gdouble ags_vst_range_parameter_get_min ( AgsVstRangeParameter * range_parameter )

Get minimum.

Parameters

range_parameter the range parameter

Returns: the minimum

Since: 5.0.0

◆ ags_vst_range_parameter_new_full()

AgsVstRangeParameter * ags_vst_range_parameter_new_full	(	gunichar2 *	title,
		guint32	tag,
		gunichar2 *	units,
		gdouble	min_plain,
		gdouble	max_plain,
		gdouble	default_value_plain,
		gint32	step_count,
		gint32	flags,
		gint32	unit_id,
		gunichar2 *	short_title
	)

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

Parameters

title	the title
tag	the tag
units	the units
min_plain	the plain minimum
max_plain	the plain maximum
default_value_plain	the default plain value
step_count	the step count
flags	the flags
unit_id	the unit identifier
short_title	the short title

Returns: the AgsVstRangeParameter

Since: 5.0.0

◆ ags_vst_range_parameter_new_with_info()

AgsVstRangeParameter * ags_vst_range_parameter_new_with_info	(	AgsVstParameterInfo *	param_info,
		gdouble	min,
		gdouble	max
	)

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

Parameters

param_info	the parameter info
min	the minimum
max	the maximum

Returns: the AgsVstRangeParameter

Since: 5.0.0

◆ ags_vst_range_parameter_set_max()

void ags_vst_range_parameter_set_max	(	AgsVstRangeParameter *	range_parameter,
		gdouble	value
	)

Set maximum.

Parameters

range_parameter	the range parameter
value	the maximum

Since: 5.0.0

◆ ags_vst_range_parameter_set_min()

void ags_vst_range_parameter_set_min	(	AgsVstRangeParameter *	range_parameter,
		gdouble	value
	)

Set minimum.

Parameters

range_parameter	the range parameter
value	the minimum

Since: 5.0.0

◆ ags_vst_range_parameter_to_normalized()

gdouble ags_vst_range_parameter_to_normalized	(	AgsVstRangeParameter *	range_parameter,
		gdouble	plain_value
	)

To normalized.

Parameters

range_parameter	the range parameter
plain_value	the plain value

Returns: the normalized value

Since: 5.0.0

◆ ags_vst_range_parameter_to_plain()

gdouble ags_vst_range_parameter_to_plain	(	AgsVstRangeParameter *	range_parameter,
		gdouble	value_normalized
	)

To plain.

Parameters

range_parameter	the range parameter
value_normalized	the normalized value

Returns: the plain value

Since: 5.0.0

◆ ags_vst_range_parameter_to_string()

void ags_vst_range_parameter_to_string	(	AgsVstRangeParameter *	range_parameter,
		gdouble	value_normalized,
		AgsVstString128	string
	)

To string.

Parameters

range_parameter	the range parameter
value_normalized	the normalized value
string	the string

Since: 5.0.0

◆ ags_vst_string_list_parameter_append_string()

void ags_vst_string_list_parameter_append_string	(	AgsVstStringListParameter *	string_list_parameter,
		AgsVstString128	string
	)

Append string.

Parameters

string_list_parameter	the string list parameter
string	the string

Since: 5.0.0

◆ ags_vst_string_list_parameter_from_string()

gboolean ags_vst_string_list_parameter_from_string	(	AgsVstStringListParameter *	string_list_parameter,
		gunichar2 *	string,
		gdouble *	value_normalized
	)

From string.

Parameters

string_list_parameter	the string list parameter
string	the string
value_normalized	the value normalized

Returns: true if success, otherwise false

Since: 5.0.0

◆ ags_vst_string_list_parameter_new_full()

AgsVstStringListParameter * ags_vst_string_list_parameter_new_full	(	gunichar2 *	title,
		guint32	tag,
		gunichar2 *	units,
		gint32	flags,
		gint32	unit_id,
		gunichar2 *	short_title
	)

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

Parameters

title	the title
tag	the tag
units	the units
flags	the flags
unit_id	the unit identifier
short_title	the short title

Returns: the AgsVstStringListParameter

Since: 5.0.0

◆ ags_vst_string_list_parameter_new_with_info()

AgsVstStringListParameter * ags_vst_string_list_parameter_new_with_info ( AgsVstParameterInfo * param_info )

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

Parameters

param_info the parameter info

Returns: the AgsVstStringListParameter

Since: 5.0.0

◆ ags_vst_string_list_parameter_replace_string()

gboolean ags_vst_string_list_parameter_replace_string	(	AgsVstStringListParameter *	string_list_parameter,
		gint32	index,
		AgsVstString128	string
	)

Replace string.

Parameters

string_list_parameter	the string list parameter
index	the index
string	the string

Returns: true if success, otherwise false

Since: 5.0.0

◆ ags_vst_string_list_parameter_to_normalized()

gdouble ags_vst_string_list_parameter_to_normalized	(	AgsVstStringListParameter *	string_list_parameter,
		gdouble	plain_value
	)

To normalized.

Parameters

string_list_parameter	the string list parameter
plain_value	the plain value

Returns: the normalized value

Since: 5.0.0

◆ ags_vst_string_list_parameter_to_plain()

gdouble ags_vst_string_list_parameter_to_plain	(	AgsVstStringListParameter *	string_list_parameter,
		gdouble	value_normalized
	)

To plain.

Parameters

string_list_parameter	the string list parameter
value_normalized	the value normalized

Returns: the plain value

Since: 5.0.0

◆ ags_vst_string_list_parameter_to_string()

void ags_vst_string_list_parameter_to_string	(	AgsVstStringListParameter *	string_list_parameter,
		gdouble	value_normalized,
		AgsVstString128	string
	)

To string.

Parameters

string_list_parameter	the string list parameter
value_normalized	the value normalized
string	the string

Since: 5.0.0

Typedefs

Functions

Typedef Documentation

◆ Parameter

◆ ParameterContainer

◆ RangeParameter

◆ StringListParameter

Function Documentation

◆ ags_vst_parameter_container_add_parameter()

◆ ags_vst_parameter_container_add_parameter_extended()

◆ ags_vst_parameter_container_add_parameter_with_info()

◆ ags_vst_parameter_container_get_parameter()

◆ ags_vst_parameter_container_get_parameter_by_index()

◆ ags_vst_parameter_container_get_parameter_count()

◆ ags_vst_parameter_container_init()

◆ ags_vst_parameter_container_new()

◆ ags_vst_parameter_container_remove_all()

◆ ags_vst_parameter_delete()

◆ ags_vst_parameter_from_string()

◆ ags_vst_parameter_get_info()

◆ ags_vst_parameter_get_normalized()

◆ ags_vst_parameter_get_precision()

◆ ags_vst_parameter_get_unit_id()

◆ ags_vst_parameter_new()

◆ ags_vst_parameter_new_full()

◆ ags_vst_parameter_new_with_info()

◆ ags_vst_parameter_set_normalized()

◆ ags_vst_parameter_set_precision()

◆ ags_vst_parameter_set_unit_id()

◆ ags_vst_parameter_to_normalized()

◆ ags_vst_parameter_to_plain()

◆ ags_vst_parameter_to_string()

◆ ags_vst_range_parameter_from_string()

◆ ags_vst_range_parameter_get_max()

◆ ags_vst_range_parameter_get_min()

◆ ags_vst_range_parameter_new_full()

◆ ags_vst_range_parameter_new_with_info()

◆ ags_vst_range_parameter_set_max()

◆ ags_vst_range_parameter_set_min()

◆ ags_vst_range_parameter_to_normalized()

◆ ags_vst_range_parameter_to_plain()

◆ ags_vst_range_parameter_to_string()

◆ ags_vst_string_list_parameter_append_string()

◆ ags_vst_string_list_parameter_from_string()

◆ ags_vst_string_list_parameter_new_full()

◆ ags_vst_string_list_parameter_new_with_info()

◆ ags_vst_string_list_parameter_replace_string()

◆ ags_vst_string_list_parameter_to_normalized()

◆ ags_vst_string_list_parameter_to_plain()

◆ ags_vst_string_list_parameter_to_string()