C language API for Vamp plugins. More...

#include <vamp.h>

Public Attributes
const char *	identifier
	Computer-usable name of the parameter.
const char *	name
	Human-readable name of the parameter.
const char *	description
	Human-readable short text about the parameter.
const char *	unit
	Human-readable unit of the parameter.
float	minValue
	Minimum value.
float	maxValue
	Maximum value.
float	defaultValue
	Default value.
int	isQuantized
	1 if parameter values are quantized to a particular resolution.
float	quantizeStep
	Quantization resolution, if isQuantized.
const char **	valueNames
	Human-readable names of the values, if isQuantized.

Detailed Description

C language API for Vamp plugins.

This is the formal plugin API for Vamp. Plugin authors may prefer to use the C++ classes provided in the Vamp plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.

IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the Vamp plugin SDK for further details and plugin lifecycle documentation.

Definition at line 71 of file vamp.h.