PortGroup Struct Reference

#include <DistrhoDetails.hpp>

Public Attributes
String	name
String	symbol

Detailed Description

Port Group.
Allows to group together audio/cv ports or parameters.

Each unique group MUST have an unique symbol and a name. A group can be applied to both inputs and outputs (at the same time). The same group cannot be used in audio ports and parameters.

When both audio and parameter groups are used, audio groups MUST be defined first. That is, group indexes start with audio ports, then parameters.

An audio port group logically combines ports which should be considered part of the same stream.
For example, two audio ports in a group may form a stereo stream.

A parameter group provides meta-data to the host to indicate that some parameters belong together.

The use of port groups is completely optional.

See also

Plugin::initPortGroup, AudioPort::group, Parameter::group

Member Data Documentation

name

String PortGroup::name

The name of this port group.
A port group 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.

symbol

String PortGroup::symbol

The symbol of this port group.
A port group 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

Port group symbols MUST be unique within a plugin instance.

---

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

• distrho/DistrhoDetails.hpp