Base Plugin Structs

Namespaces
namespace	ParameterDesignationSymbols

Classes
struct	AudioPort
struct	ParameterRanges
struct	ParameterEnumerationValue
struct	ParameterEnumerationValues
struct	Parameter
struct	PortGroup
struct	State
struct	MidiEvent
struct	TimePosition

Enumerations
enum	ParameterDesignation { kParameterDesignationNull , kParameterDesignationBypass , kParameterDesignationReset }
enum	PredefinedPortGroupsIds { kPortGroupNone = (uint32_t)-1 , kPortGroupMono = (uint32_t)-2 , kPortGroupStereo = (uint32_t)-3 }

Detailed Description

Enumeration Type Documentation

ParameterDesignation

enum ParameterDesignation

Parameter designation.
Allows a parameter to be specially designated for a task, like bypass and reset.

Each designation is unique, there must be only one parameter that uses it.
The use of designated parameters is completely optional.

Note

Designated parameters have strict ranges.

See also

ParameterRanges::adjustForDesignation()

Enumerator
kParameterDesignationNull	Null or unset designation.
kParameterDesignationBypass	Bypass designation. When on (> 0.5f), it means the plugin must run in a bypassed state.
kParameterDesignationReset	Reset designation. When on (> 0.5f), it means the plugin should reset its internal processing state (like filters, oscillators, envelopes, lfos, etc) and kill all voices.

PredefinedPortGroupsIds

enum PredefinedPortGroupsIds

Predefined Port Groups Ids.

This enumeration provides a few commonly used groups for convenient use in plugins. For preventing conflicts with user code, negative values are used here. When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential.

See also

PortGroup

Enumerator
kPortGroupNone	Null or unset port group.
kPortGroupMono	A single channel audio group.
kPortGroupStereo	A 2-channel discrete stereo audio group, where the 1st audio port is the left channel and the 2nd port is the right channel.