vst_parameter_properties_t Struct Reference

Information about a parameter. More...

#include <vst.h>

Data Fields
float	step_f32
	Float Step value.
float	step_small_f32
	Float small step value This is used for "tiny" changes.
float	step_large_f32
	Float large step value This is used for "huge" changes.
char	name [VST_BUFFER_SIZE_PARAM_LONG_NAME]
	Human-readable name for this parameter.
uint32_t	flags
	Parameter Flags.
int32_t	min_value_i32
	Minimum Integer value.
int32_t	max_value_i32
	Maximum Integer value.
int32_t	step_i32
	Integer Step value.
char	label [VST_BUFFER_SIZE_PARAM_LABEL]
	Short Human-readable label for this parameter.
uint16_t	index
	Display order index.
uint16_t	category
	Category index.
uint16_t	num_parameters_in_category
	How many parameters are in this category? This allows the plug-in to specify the same category multiple times.
char	category_label [VST_BUFFER_SIZE_CATEGORY_LABEL]
	Human-readable name for the category this parameter is in.

Detailed Description

Information about a parameter.

@important Many VST hosts and plug-ins expect their parameters to be normalized within 0.0 and 1.0.

Definition at line 463 of file vst.h.

Field Documentation

category

uint16_t vst_parameter_properties_t::category

Category index.

Must either be 0 for no category, or any number increasing from 1 onwards.

Note

Requires VST_PARAMETER_FLAG_CATEGORY to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 547 of file vst.h.

category_label

char vst_parameter_properties_t::category_label[VST_BUFFER_SIZE_CATEGORY_LABEL]

Human-readable name for the category this parameter is in.

Note

Requires VST_PARAMETER_FLAG_CATEGORY to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 565 of file vst.h.

flags

uint32_t vst_parameter_properties_t::flags

Parameter Flags.

Any combination of VST_PARAMETER_FLAG.

Definition at line 503 of file vst.h.

index

uint16_t vst_parameter_properties_t::index

Display order index.

Note

Requires VST_PARAMETER_FLAG_INDEX to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 538 of file vst.h.

label

char vst_parameter_properties_t::label[VST_BUFFER_SIZE_PARAM_LABEL]

Short Human-readable label for this parameter.

I have no idea why this exists?

Note

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 531 of file vst.h.

max_value_i32

int32_t vst_parameter_properties_t::max_value_i32

Maximum Integer value.

Note

Requires VST_PARAMETER_FLAG_INTEGER_LIMITS to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 517 of file vst.h.

min_value_i32

int32_t vst_parameter_properties_t::min_value_i32

Minimum Integer value.

Note

Requires VST_PARAMETER_FLAG_INTEGER_LIMITS to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 510 of file vst.h.

name

char vst_parameter_properties_t::name[VST_BUFFER_SIZE_PARAM_LONG_NAME]

Human-readable name for this parameter.

Note

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 497 of file vst.h.

num_parameters_in_category

uint16_t vst_parameter_properties_t::num_parameters_in_category

How many parameters are in this category? This allows the plug-in to specify the same category multiple times.

Note

Requires VST_PARAMETER_FLAG_CATEGORY to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 555 of file vst.h.

step_f32

float vst_parameter_properties_t::step_f32

Float Step value.

Some hosts and plug-ins expect this to be within 0 and 1.0.

Note

Requires VST_PARAMETER_FLAG_STEP_FLOAT to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 471 of file vst.h.

step_i32

int32_t vst_parameter_properties_t::step_i32

Integer Step value.

Note

Requires VST_PARAMETER_FLAG_STEP_INT to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 524 of file vst.h.

step_large_f32

float vst_parameter_properties_t::step_large_f32

Float large step value This is used for "huge" changes.

Some hosts and plug-ins expect this to be within 0 and 1.0.

Note

Requires VST_PARAMETER_FLAG_STEP_FLOAT to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 491 of file vst.h.

step_small_f32

float vst_parameter_properties_t::step_small_f32

Float small step value This is used for "tiny" changes.

Some hosts and plug-ins expect this to be within 0 and 1.0.

Note

Requires VST_PARAMETER_FLAG_STEP_FLOAT to be set.

Ignored if VST_EFFECT_FLAG_EDITOR is set.

Definition at line 481 of file vst.h.

---

The documentation for this struct was generated from the following file:

• include/vst.h