State Hints

Variables
static constexpr const uint32_t	kStateIsHostReadable = 0x01
static constexpr const uint32_t	kStateIsHostWritable = 0x02 | kStateIsHostReadable
static constexpr const uint32_t	kStateIsFilenamePath = 0x04 | kStateIsHostWritable
static constexpr const uint32_t	kStateIsBase64Blob = 0x08
static constexpr const uint32_t	kStateIsOnlyForDSP = 0x10
static constexpr const uint32_t	kStateIsOnlyForUI = 0x20
static constexpr const uint32_t	kStateIsParameterSnapshot = 0x40
static constexpr const uint32_t	kStateIsRequired = 0x80

Detailed Description

Various state hints.

See also

State::hints

Variable Documentation

kStateIsHostReadable

const uint32_t kStateIsHostReadable = 0x01

staticconstexpr

State is visible and readable by hosts that support string-type plugin parameters.

kStateIsHostWritable

const uint32_t kStateIsHostWritable = 0x02 | kStateIsHostReadable

staticconstexpr

State is writable by the host, allowing users to arbitrarily change the state.
For obvious reasons a writable state is also readable by the host.

kStateIsFilenamePath

const uint32_t kStateIsFilenamePath = 0x04 | kStateIsHostWritable

staticconstexpr

State is a filename path instead of a regular string.
The readable and writable hints are required for filenames to work, and thus are automatically set.

kStateIsBase64Blob

const uint32_t kStateIsBase64Blob = 0x08

staticconstexpr

State is a base64 encoded string.

kStateIsOnlyForDSP

const uint32_t kStateIsOnlyForDSP = 0x10

staticconstexpr

State is for Plugin/DSP side only, meaning there is never a need to notify the UI when it changes.

kStateIsOnlyForUI

const uint32_t kStateIsOnlyForUI = 0x20

staticconstexpr

State is for UI side only.
If the DSP and UI are separate and the UI is not available, this property won't be saved.

kStateIsParameterSnapshot

const uint32_t kStateIsParameterSnapshot = 0x40

staticconstexpr

State value is an immutable complete parameter snapshot.

Applying this state is a non-realtime operation at the plugin boundary. Adapters must refresh their parameter caches and host/UI mirrors as one complete update; they must not replay it as individual UI parameter edits.

kStateIsRequired

const uint32_t kStateIsRequired = 0x80

staticconstexpr

This key must occur exactly once when restoring a complete host state. Opt in for authoritative snapshots whose absence must not fall back to a partial parameter recall. Other plugins retain their existing restore policy.