AudioPort Struct Reference

#include <DistrhoDetails.hpp>

Public Member Functions
	AudioPort () noexcept

Public Attributes
uint32_t	hints
String	name
String	symbol
uint32_t	groupId

Detailed Description

Audio Port.

Can be used as CV port by specifying kAudioPortIsCV in hints,
but this is only supported in LV2 and JACK standalone formats.

Constructor & Destructor Documentation

AudioPort()

AudioPort::AudioPort ( )

inlinenoexcept

Default constructor for a regular audio port.

Member Data Documentation

hints

uint32_t AudioPort::hints

Hints describing this audio port.

See also

Audio Port Hints

name

String AudioPort::name

The name of this audio port.
An audio port 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 AudioPort::symbol

The symbol of this audio port.
An audio port 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

Audio port and parameter symbols MUST be unique within a plugin instance.

groupId

uint32_t AudioPort::groupId

The group id that this audio/cv port belongs to. No group is assigned by default.

You can use a group from PredefinedPortGroups or roll your own.
When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential.

See also

PortGroup, Plugin::initPortGroup

---

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

• distrho/DistrhoDetails.hpp