Parameter Struct Reference

#include <DistrhoPlugin.hpp>

Public Member Functions
	Parameter () noexcept

Public Attributes
uint32_t	hints
String	name
String	symbol
String	unit
ParameterRanges	ranges

Detailed Description

Parameter.

Constructor & Destructor Documentation

Parameter::Parameter ( )

inlinenoexcept

Default constructor for a null parameter.

Member Data Documentation

uint32_t Parameter::hints

Hints describing this parameter.

See also

Parameter Hints

String Parameter::name

The name of this parameter. A parameter name can contain any character, but hosts might have a hard time with non-ascii ones. The name doesn't have to be unique within a plugin instance, but it's recommended.

String Parameter::symbol

The symbol of this parameter. A parameter symbol is a short restricted name used as a machine and human readable identifier. The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9.

Note

: Parameter symbols MUST be unique within a plugin instance.

String Parameter::unit

The unit of this parameter. This means something like "dB", "kHz" and "ms". Can be left blank if a unit does not apply to this parameter.

ParameterRanges Parameter::ranges

Ranges of this parameter. The ranges describe the default, minimum and maximum values.

---

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

• distrho/DistrhoPlugin.hpp