#include <DistrhoDetails.hpp>

Public Member Functions
	State () noexcept

Public Attributes
uint32_t	hints

String	key

String	defaultValue

String	label

String	description

Detailed Description

State.

In DPF states refer to key:value string pairs, used to store arbitrary non-parameter data.
By default states are completely internal to the plugin and not visible by the host.
Flags can be set to allow hosts to see and/or change them.

TODO API under construction

Constructor & Destructor Documentation

◆ State()

State::State ( )

inlinenoexcept

Default constructor for a null state.

Member Data Documentation

◆ hints

uint32_t State::hints

Hints describing this state.

Note: Changing these hints can break compatibility with previously saved data.

See also: State Hints

◆ key

String State::key

The key or "symbol" of this state.
A state key is a short restricted name used as a machine and human readable identifier.

Note: State keys MUST be unique within a plugin instance. TODO define rules for allowed characters, must be usable as URI non-encoded parameters

◆ defaultValue

String State::defaultValue

The default value of this state.
Can be left empty if considered a valid initial state.

◆ label

String State::label

String representation of this state.

◆ description

String State::description

An extensive description/comment about this state.

Note: This value is optional and only used for LV2.

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

distrho/DistrhoDetails.hpp

Public Member Functions

Public Attributes